From 128399c14120a0a5eab707141ada0ede0e75e38f Mon Sep 17 00:00:00 2001 From: Jody Klymak Date: Wed, 18 Oct 2017 12:26:17 -0700 Subject: [PATCH] Changes to better highlight development-workflow in docs --- .github/PULL_REQUEST_TEMPLATE.md | 12 ++++++------ doc/devel/contributing.rst | 7 ++++++- 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ced3ee9a82b3..9d9ddcd8303b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,15 +1,15 @@ +https://matplotlib.org/devdocs/devel/index.html + +For help with git and github workflow, please see https://matplotlib.org/devel/gitwash/development_workflow.html + +Please do not create the PR out of master, but out of a separate branch. --> - ## PR Summary @@ -21,7 +21,7 @@ detail. Why is this change required? What problem does it solve?--> ## PR Checklist - [ ] Has Pytest style unit tests -- [ ] Code is PEP 8 compliant +- [ ] Code is PEP 8 compliant - [ ] New features are documented, with examples if plot related - [ ] Documentation is sphinx and numpydoc compliant - [ ] Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there) diff --git a/doc/devel/contributing.rst b/doc/devel/contributing.rst index eb682e3bae41..87cc9924aed0 100644 --- a/doc/devel/contributing.rst +++ b/doc/devel/contributing.rst @@ -155,7 +155,12 @@ How to contribute The preferred way to contribute to Matplotlib is to fork the `main repository `__ on GitHub, -then submit a "pull request" (PR): +then submit a "pull request" (PR). + +The best practices for using GitHub to make PRs to Matplotlib are +documented in the :ref:`development-workflow` section. + +A brief overview is: 1. `Create an account `_ on GitHub if you do not already have one.