8000 Issue #520: Made https://devguide.python.org/committing/ simpler by jablonskidev · Pull Request #650 · python/devguide · GitHub
[go: up one dir, main page]

Skip to content

Issue #520: Made https://devguide.python.org/committing/ simpler #650

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
merged 42 commits into from
Jan 30, 2021
Merged
Changes from 1 commit
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
c7de522
First draft: make text easier to skim
jablonskidev Dec 23, 2020
b6acaca
Change list spacing: learning rst
jablonskidev Dec 23, 2020
a3a92f7
Learning rst
jablonskidev Dec 23, 2020
e0742b1
Learning rst
jablonskidev Dec 23, 2020
0bd9226
Fix list indentation
jablonskidev Dec 23, 2020
6e26e24
Remove monospace when conflicted with bold
jablonskidev Dec 23, 2020
5be3269
Allcaps for NEWS
jablonskidev Dec 23, 2020
ff18318
Sentence case for subheadings
jablonskidev Dec 23, 2020
1f7687c
Allcaps NEWS
jablonskidev Dec 23, 2020
2b91e10
Remove inconsistent bold
jablonskidev Dec 23, 2020
ef292e0
Reader-focused phrasing
jablonskidev Dec 23, 2020
e6b848b
Verb tense
jablonskidev Dec 23, 2020
f4e9e83
Add empty lines between list items: learn rst
jablonskidev Dec 24, 2020
39d40d8
Add whitespace: learn rst
jablonskidev Dec 24, 2020
ed2dc39
Remove double empty lines between list items
jablonskidev Dec 24, 2020
4634697
Replace "PR" with "pull request"
jablonskidev Dec 24, 2020
64de2c8
Line length and spacing
jablonskidev Dec 24, 2020
cfae673
Typo & consistent terminology
jablonskidev Dec 24, 2020
9221842
Light proofread
jablonskidev Dec 24, 2020
25a885a
Made line under heading long enough
jablonskidev Dec 24, 2020
31ed26d
Add link to CLA
jablonskidev Dec 24, 2020
e817721
Changed ordered list to unordered list
jablonskidev Dec 24, 2020
1209680
Change list formatting
jablonskidev Dec 24, 2020
a79e2d1
Removed empty lines in list
jablonskidev Dec 24, 2020
d543c51
Changed bolding
jablonskidev Dec 24, 2020
dc087d3
Changed line length for list formatting
jablonskidev Dec 24, 2020
da180f8
Changed word order for clarity without monospace
jablonskidev Dec 24, 2020
567aa81
Added monospace to bold sections
jablonskidev Dec 24, 2020
2271326
Font formatting
jablonskidev Dec 24, 2020
623cea4
Removed redundancy
jablonskidev Dec 24, 2020
10e28fc
Monospace NEWS, clean double empty lines
jablonskidev Dec 24, 2020
9caaf03
Font formatting
jablonskidev Dec 24, 2020
9f7ca66
Spelling & font formatting
jablonskidev Dec 24, 2020
3b530a9
Font formatting
jablonskidev Dec 24, 2020
afb0c74
Added a reference to b.p.o.
jablonskidev Dec 28, 2020
6c7cf90
Fixed monospace
jablonskidev Dec 28, 2020
864c27a
Removed instructions to run patchcheck
jablonskidev Jan 4, 2021
f4e718a
Put patchcheck instructions back in
jablonskidev Jan 5, 2021
76aea19
Corrected wording in the reference to b.p.o.
jablonskidev Jan 9, 2021
d1b5acf
Implemented Brett's feedback
jablonskidev Jan 10, 2021
91f046e
Addressed issue #655
jablonskidev Jan 23, 2021
6c46cfb
Update committing.rst
brettcannon Jan 30, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Change list formatting
  • Loading branch information
jablonskidev authored Dec 24, 2020
commit 12096802a121e5c7808d6d3a234c294de40f2295
68 changes: 36 additions & 32 deletions committing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,50 +15,53 @@ Before you can accept a pull request, you need to make sure that it is ready
to enter the public source tree. Ask yourself the following questions:


* **Was the pull request first made against the master branch?** The
only branch that receives new features is ``master``, the in-development
branch.
* **Was the pull request first made against the master branch?**
The only branch that receives new features is ``master``, the
in-development branch.


* **Are there comments on the pull request?** Look for explanations about
whether the code coverage increased or stayed the same.
* **Are there comments on the pull request?**
Look for explanations about whether the code coverage increased or
stayed the same.


* **Are the changes acceptable?** If you want to share your work-in-progress
code on a feature or bugfix, then you can open a ``WIP``-prefixed pull
request, publish patches on the `issue tracker
<https://bugs.python.org/>`_, or create a public fork of the repository.
* **Are the changes acceptable?**
If you want to share your work-in-progress code on a feature or bugfix,
then you can open a ``WIP``-prefixed pull request, publish patches on
the `issue tracker <https://bugs.python.org/>`_, or create a public
fork of the repository.


* **Does the check on the pull request show that the test suite passes?**
* **Does the check on the pull request show that the test suite passes?**
:ref:`Run the entire test suite <runtests>` to ensure that it passes.
Running a single test is not enough since the changes may have unforeseen
effects on other tests or library modules.


* **Is the patch in a good state?** Check :ref:`patch` and
:ref:`helptriage` to review what is expected of a patch.
* **Is the patch in a good state?**
Check :ref:`patch` and :ref:`helptriage` to review what is expected of
a patch.


* **Do the changes meet the requirements of the patch checklist?**
:ref:`Run patchcheck <patchcheck>` to perform a quick confidence
check on the changes.


* **Does the patch break backwards-compatibility without a strong
reason?** :ref:`Run the entire test suite <runtests>` to
make sure that everything still passes. If there is a change to the
semantics, then there needs to be a strong reason, because it will
cause some peoples' code to break. If you are unsure if the breakage
is worth it, then ask on python-dev.
* **Does the patch break backwards-compatibility without a strong reason?**
:ref:`Run the entire test suite <runtests>` to make sure that everything
still passes. If there is a change to the semantics, then there needs to
be a strong reason, because it will cause some peoples' code to break.
If you are unsure if the breakage is worth it, then ask on python-dev.


* **Were configure and pyconfig.h.in regenerated?** Regenerate them
if necessary.
* **Were configure and pyconfig.h.in regenerated?**
Regenerate them if necessary.


* **Were appropriate labels added to signify necessary backporting of the
pull request?** If it is determined that a pull request needs to be
pull request?**
If it is determined that a pull request needs to be
backported into one or more of the maintenance branches, then a core
developer can apply the label ``needs backport to X.Y`` to the pull
request. Once the backport pull request has been created, remove the
Expand All @@ -68,7 +71,8 @@ to enter the public source tree. Ask yourself the following questions:


* **Does the pull request have a label indicating that the submitter has
signed the CLA?** Make sure that the contributor has signed a `Contributor
signed the CLA?**
Make sure that the contributor has signed a `Contributor
Licensing Agreement <https://www.python.org/psf/contrib/contrib-form/>`_
(CLA), unless their change has no possible intellectual property
associated with it (e.g. fixing a spelling mistake in documentation).
Expand All @@ -78,23 +82,23 @@ to enter the public source tree. Ask yourself the following questions:
process, write to contributors@python.org.


* **Was the contributor added to Misc/ACKS?** Make sure that
the patch is attributed correctly with the contributor's name in
``Misc/ACKS``. If the patch has been heavily modified, then "Initial
patch by <x>" is an appropriate alternate wording. GitHub now
* **Was the contributor added to Misc/ACKS?**
Make sure that the patch is attributed correctly with the contributor's
name in ``Misc/ACKS``. If the patch has been heavily modified, then
"Initial patch by <x>" is an appropriate alternate wording. GitHub now
supports `multiple authors
<https://help.github.com/articles/creating-a-commit-with-multiple-authors/>`_
in a commit. Add ``Co-authored-by: name <name@example.com>`` at the end
of the commit message.


* **Were What's New in Python (in Doc/whatsnew/) and
Misc/NEWS.d/next updated?** If the change is particularly interesting
for end users (e.g. new features, significant improvements, or
backwards-incompatible changes), then an entry in the
``What's New in Python`` document (in ``Doc/whatsnew/``) should be added
as well. Changes that affect only documentation generally do not require
a NEWS entry. (See the following section for more information.)
Misc/NEWS.d/next updated?**
If the change is particularly interesting for end users (e.g. new features,
significant improvements, or backwards-incompatible changes), then an
entry in the ``What's New in Python`` document (in ``Doc/whatsnew/``) should
be added as well. Changes that affect only documentation generally do not
require a NEWS entry. (See the following section for more information.)



Expand Down
0