From 82fd1fe263df71936682b3b03d119ecafc764ae0 Mon Sep 17 00:00:00 2001 From: Mariatta Date: Fri, 13 Jul 2018 14:22:35 -0700 Subject: [PATCH] Update the PR template and Contributing Guidelines (#738) --- .github/PULL_REQUEST_TEMPLATE.md | 8 +++++--- CONTRIBUTING.rst | 30 +++++++++++++++++++++++++++--- 2 files changed, 32 insertions(+), 6 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 80f6448d0..3c4934ac8 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,8 +2,10 @@ Please include the PEP number in the pull request title, example: -``` PEP NNN: Summary of the changes made -``` ---> \ No newline at end of file +In addition, please sign the CLA. + +For more information, please read our Contributing Guidelines (CONTRIBUTING.rst) + +--> diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index bfd8c93e6..8f01b5802 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -8,9 +8,16 @@ PEP 0, the index PEP, is now automatically generated, and not committed to the r Before writing a new PEP ------------------------ -Start with a discussion in `python-ideas `_ -mailing list to determine if the idea is PEP-able. More details about it in -`PEP 1 `_. +Has this idea been proposed on `python-ideas `_ +and received general acceptance as being an idea worth pursuing? (if not then +please start a discussion there before submitting a pull request). + +More details about it in `PEP 1 `_. + +Do you have an implementation of your idea? (this is important for when you +propose this PEP to `python-dev `_ +as code maintenance is a critical aspect of all PEP proposals prior to a +final decision; in special circumstances an implementation can be deferred) Commit messages @@ -20,6 +27,23 @@ When committing to a PEP, please always include the PEP number in the subject title. For example, ``PEP NNN: ``. +Sign the CLA +------------ + +Before you hit "Create pull request", please take a moment to ensure that this +project can legally accept your contribution by verifying you have signed the +PSF Contributor Agreement: + + https://www.python.org/psf/contrib/contrib-form/ + +If you haven't signed the CLA before, please follow the steps outlined in the +CPython devguide to do so: + + https://devguide.python.org/pullrequest/#licensing + +Thanks again to your contribution and we look forward to looking at it! + + Code of Conduct ---------------