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
10000
Diff view
Prev Previous commit
Next Next commit
Monospace NEWS, clean double empty lines
  • Loading branch information
jablonskidev authored Dec 24, 2020
commit 10e28fc1b04efac5fd85bf0edd6ad5e2705d1529
20 changes: 8 additions & 12 deletions committing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ to enter the public source tree. Ask yourself the following questions:
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.)
require a ``NEWS`` entry. (See the following section for more information.)


Updating NEWS and What's New in Python
Expand All @@ -94,12 +94,12 @@ 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 documentation only generally do not require
a NEWS entry.
a ``NEWS`` entry.

There are two notable exceptions to this general principle, and they
both relate to changes that:

* Already have a NEWS entry
* Already have a ``NEWS`` entry
* Have not yet been included in any formal release (including alpha
and beta releases)

Expand All @@ -111,18 +111,18 @@ These are the two exceptions:
an alpha and then cut prior to the first beta).

#. **If a change is a fix (or other adjustment) to an earlier unreleased
change and the original NEWS entry remains valid**, then no additional
change and the original ``NEWS`` entry remains valid**, then no additional
entry is needed.

If a change needs an entry in ``What's New in Python``, then it very
likely not suitable for including in a maintenance release.

NEWS entries go into the ``Misc/NEWS.d`` directory as individual files. The
NEWS entry can be created by using `blurb-it <https://blurb-it.herokuapp.com/>`_,
``NEWS`` entries go into the ``Misc/NEWS.d`` directory as individual files. The
``NEWS`` entry can be created by using `blurb-it <https://blurb-it.herokuapp.com/>`_,
or the `blurb <https://pypi.org/project/blurb/>`_ tool and its ``blurb add``
command.

If you are unable to use the tool, then you can create the NEWS entry file
If you are unable to use the tool, then you can create the ``NEWS`` entry file
manually. The ``Misc/NEWS.d`` directory contains a sub-directory named
``next``, which contains various sub-directories representing classifications
for what was affected (e.g. ``Misc/NEWS.d/next/Library`` for changes relating
Expand All @@ -141,7 +141,7 @@ to the standard library). The file name itself should be in the format
As a result, a file name can look something like
``Misc/NEWS.d/next/Library/2017-05-27-16-46-23.bpo-12345.Yl4gI2.rst``.

The contents of a NEWS file should be valid reStructuredText. An 80 character
The contents of a ``NEWS`` file should be valid reStructuredText. An 80 character
column width should be used. There is no indentation or leading marker in the
file (e.g. ``-``). There is also no need to start the entry with the issue
number since it is part of the file name. You can use
Expand All @@ -168,26 +168,22 @@ Working with Git_
As a core developer, you have the ability to push changes to the official
Python repositories, so you need to be careful with your workflow:


* **You should not push new branches to the main repository.** You can
still use them in the fork that you use for the development of patches.
You can also push these branches to a separate public repository
for maintenance work before it is integrated into the main repository.


* **You should not commit directly into the master branch, or any of the
maintenance branches (currently 3.9 and 3.8).** You should commit
against your own feature branch, and then create a pull request.


* **For a small change, you can make a quick edit through the GitHub web UI.**
If you choose to use the web UI, be aware that GitHub will
create a new branch in the main CPython repository rather than in your fork.
Delete this newly created branch after it has been merged into the
``master`` branch or any of the maintenance branches. To keep the CPython
repository tidy, remove the new branch within a few days.


Keep a fork of the main repository, since it will allow you to revert all
local changes (even committed ones) if you're not happy with your local
clone.
Expand Down
0