-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Meta: Clearly document current guidance for changing existing PEPs #2378
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
CAM-Gerlach
merged 8 commits into
python:main
from
CAM-Gerlach:meta-contrib-guide-change-policy
Apr 6, 2022
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
74a3060
Meta: Document expectations for changing existing PEPs in contrib guide
CAM-Gerlach 0e35681
Meta: Clarify commit message/PR title prefixes in contrib guide
CAM-Gerlach 3f49e45
Meta: Further improve change policy in CG per Jelle's feedback
CAM-Gerlach 6cafac8
Meta: Reduce verbosity and perscriptiveness of changes section in CG
CAM-Gerlach 0f278da
Meta: Move more general/normative PEP modification guidance to PEP 1
CAM-Gerlach ccf9770
Meta: Further revise PEP change guidance to reflect current reality
CAM-Gerlach 3968613
Meta: Update, simplify and consolidate guidance on changing PEPs
CAM-Gerlach 58e7055
PEP 1: Remove sentance explictly discussing changing governance PEPs
CAM-Gerlach File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,12 +18,39 @@ first in an appropriate venue, drafting a PEP and gathering feedback, and | |
developing at least a prototype reference implementation of your idea. | ||
|
||
|
||
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 Maintenance | ||
<https://peps.python.org/pep-0001/#pep-maintenance>`_ | ||
and `Changing Existing PEPs | ||
<https://peps.python.org/pep-0001/#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 | ||
a discussion venue appropriate to the PEP (such as `Typing-SIG | ||
<https://mail.python.org/archives/list/[email protected]/>`__ for static | ||
typing, or `Packaging Discourse <https://discuss.python.org/c/packaging/>`__ | ||
for packaging), or `open an issue <https://github.com/python/peps/issues>`__. | ||
|
||
|
||
Commit messages and PR titles | ||
----------------------------- | ||
|
||
When adding or modifying a PEP, please always include the PEP number in the | ||
commit summary and pull request title. | ||
For example, ``PEP NNN: <summary of changes>``. | ||
When adding or modifying a PEP, please include the PEP number in the commit | ||
summary and pull request title. For example, ``PEP NNN: <summary of changes>``. | ||
Likewise, prefix rendering infrastructure changes with ``Infra:``, linting | ||
alterations with ``Lint:`` and other non-PEP meta changes, such as updates to | ||
the Readme/Contributing Guide, issue/PR template, etc., with ``Meta:``. | ||
CAM-Gerlach marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
|
||
Sign the CLA | ||
|
@@ -122,11 +149,3 @@ or against all files with | |
.. code-block:: bash | ||
|
||
pre-commit run --all-files --hook-stage manual codespell | ||
|
||
**Note**: While fixing spelling mistakes as part of more substantive | ||
copyediting and proofreading of draft and active PEPs is okay, | ||
we generally advise against PRs that simply mass-correct minor typos on | ||
older PEPs that don't significantly impair meaning and understanding, | ||
as these tend to create a fairly high level of noise and churn for | ||
PEP readers, authors and editors relative to the amount of practical value | ||
they provide. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.