test0908
/
django
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Small corrections to committing-code docs

This commit is contained in:
Luke Plant 2012-06-08 00:02:52 +01:00
parent 33999d9871
commit f269f30544
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/internals/contributing/committing-code.txt
View File

@ -79,19 +79,19 @@ At this point, you can work on the code and continue as above.
GitHub provides a one-click merge functionality for pull requests. This should GitHub provides a one-click merge functionality for pull requests. This should
only be used if the pull request is 100% ready, and you have checked it for only be used if the pull request is 100% ready, and you have checked it for
errors (or trust the request maker enough to skip checks). Currently, it isn't errors (or trust the request maker enough to skip checks). Currently, it isn't
possible to control that the tests pass and that the docs build without possible to check that the tests pass and that the docs build without
downloading the changes to your developement environment. downloading the changes to your development environment.
When rewriting the commit history of a pull request, the goal is to make When rewriting the commit history of a pull request, the goal is to make
Django's commit history is as usable as possible: Django's commit history as usable as possible:
* If a patch contains back-and-forth commits, then rewrite those into one. * If a patch contains back-and-forth commits, then rewrite those into one.
Typically, a commit can add some code, and a second commit can fix Typically, a commit can add some code, and a second commit can fix
stylistic issues introduced in the first commit. stylistic issues introduced in the first commit.
* Separate changes to different commits by logical grouping: if you do a * Separate changes to different commits by logical grouping: if you do a
stylistic cleanup at the same time you do other changes to a file, stylistic cleanup at the same time as you do other changes to a file,
separating the changes to two different commits will make reviewing separating the changes into two different commits will make reviewing
history easier. history easier.
* Beware of merges of upstream branches in the pull requests. * Beware of merges of upstream branches in the pull requests.
@ -100,11 +100,11 @@ Django's commit history is as usable as possible:
tests nor the docs should emit warnings. tests nor the docs should emit warnings.
* Trivial and small patches usually are best done in one commit. Medium to * Trivial and small patches usually are best done in one commit. Medium to
large work should be split in multiple commits if possible. large work should be split into multiple commits if possible.
Practicality beats purity, so it is up to each committer to decide how much Practicality beats purity, so it is up to each committer to decide how much
history mangling to do for a pull request. The main points are engaging the history mangling to do for a pull request. The main points are engaging the
community, getting work done, and having an usable commit history. community, getting work done, and having a usable commit history.
.. _committing-guidlines: .. _committing-guidlines:
@ -194,7 +194,7 @@ Django's Git repository:
[1.3.x] Fixed #17028 - Changed diveintopython.org -> diveintopython.net. [1.3.x] Fixed #17028 - Changed diveintopython.org -> diveintopython.net.
Backport of 80c0cbf1c97047daed2c5b41b296bbc56fe1d7e3 from trunk. Backport of 80c0cbf1c97047daed2c5b41b296bbc56fe1d7e3 from master.
Reverting commits Reverting commits
----------------- -----------------