diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 8addbeb8b4f..dce854e3a68 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -24,15 +24,16 @@ Contributing changes to existing PEPs In general, most non-Draft/Active PEPs are considered to be historical documents rather than living specifications or documentation. Major changes to their core content usually require a new PEP, while smaller modifications may -or may not be appropriate, depending on the PEP's status. See `PEP 1 -`__ for more. - -Copyediting and proofreading Draft and Active PEPs (including fixing spelling -and formatting issues) is welcomed (subject to review by the PEP authors), -and can be done via pull request to this repo, though we generally advise -against PRs that simply mass-correct minor typos on older PEPs which don't -significantly impair meaning and understanding. +or may not be appropriate, depending on the PEP's status. See `PEP Maintenance +`_ +and `Changing Existing PEPs +`_ in PEP 1 for more. + +Copyediting and proofreading Draft and Active PEPs is welcome (subject to +review by the PEP author), and can be done via pull request to this repo. Substantive content changes should first be proposed on PEP discussion threads. +We do advise against PRs that simply mass-correct minor typos on older PEPs +which don't significantly impair meaning and understanding. If you're still unsure, we encourage you to reach out first before opening a PR here. For example, you could contact the PEP author(s), propose your idea in diff --git a/pep-0001.txt b/pep-0001.txt index 39d6f0a514f..bf52a755a9d 100644 --- a/pep-0001.txt +++ b/pep-0001.txt @@ -476,11 +476,6 @@ followed in these cases will depend on the nature and purpose of the PEP being updated. Substantive changes to governance PEPs must be reviewed by the Steering Council (by opening a `Steering Council issue`_). -Draft PEPs are freely open for discussion and proposed modification, -at the discretion of the authors, until submitted to the -Steering Council or PEP-Delegate for review and resolution. -Substantive content changes should generally be first proposed on -the PEP's discussion thread listed in its ``Discussions-To`` header. Occasionally, a Deferred or even a Withdrawn PEP may be resurrected with major updates, but it is often better to just propose a new one. @@ -705,23 +700,21 @@ Alternatively, all support files may be placed in a subdirectory called are no constraints on the names used in files. -Reporting PEP Bugs, or Submitting PEP Updates -============================================= +Changing Existing PEPs +====================== -How you report a bug, or submit a PEP update depends on several -factors, such as the maturity of the PEP, the preferences of the PEP -author, and the nature of your comments. For the early draft stages -of the PEP, it's probably best to send your comments and changes -directly to the PEP author. For more mature, or finished PEPs you may -want to submit corrections as a `GitHub issue`_ or `GitHub pull request`_ so that -your changes don't get lost. +Draft PEPs are freely open for discussion and proposed modification, at the +discretion of the authors, until submitted to the Steering Council or +PEP-Delegate for review and resolution. Substantive content changes should +generally be first proposed on the PEP's discussion thread listed in its +``Discussions-To`` header, while copyedits and corrections can be submitted +as a `GitHub issue`_ or `GitHub pull request`_. +PEP authors with write access to the PEP repository can update the PEPs +themselves by using ``git push`` or a GitHub PR to submit their changes. +For guidance on modifying other PEPs, consult the `PEP Maintenance`_ section. -When in doubt about where to send your changes, please check first -with the PEP author and/or a PEP editor. - -PEP authors with write access to the PEP repository can update the -PEPs themselves by using "git push" or the GitHub PR interface to submit their -changes. +See the `Contributing Guide`_ for additional details, and when in doubt, +please check first with the PEP author and/or a PEP editor. Transferring PEP Ownership @@ -885,6 +878,7 @@ Footnotes .. _PyPA Specifications: https://packaging.python.org/en/latest/specifications/ +.. _Contributing Guide: https://github.com/python/peps/blob/main/CONTRIBUTING.rst Copyright