summaryrefslogtreecommitdiff
path: root/docs/internals/contributing/committing-code.txt
diff options
context:
space:
mode:
authorTobias Kunze <r@rixx.de>2019-06-17 16:54:55 +0200
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2019-09-06 13:27:46 +0200
commit4a954cfd11a5d034491f87fcbc920eb97a302bb3 (patch)
tree1c92caae5d8a9b33c51ddd74b4b2061248f3915f /docs/internals/contributing/committing-code.txt
parentaddabc492bdc0191ac95d59ec34b56b34086ebb9 (diff)
Fixed #30573 -- Rephrased documentation to avoid words that minimise the involved difficulty.
This patch does not remove all occurrences of the words in question. Rather, I went through all of the occurrences of the words listed below, and judged if they a) suggested the reader had some kind of knowledge/experience, and b) if they added anything of value (including tone of voice, etc). I left most of the words alone. I looked at the following words: - simply/simple - easy/easier/easiest - obvious - just - merely - straightforward - ridiculous Thanks to Carlton Gibson for guidance on how to approach this issue, and to Tim Bell for providing the idea. But the enormous lion's share of thanks go to Adam Johnson for his patient and helpful review.
Diffstat (limited to 'docs/internals/contributing/committing-code.txt')
-rw-r--r--docs/internals/contributing/committing-code.txt16
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/internals/contributing/committing-code.txt b/docs/internals/contributing/committing-code.txt
index 64e5dfebcd..13c139c5c5 100644
--- a/docs/internals/contributing/committing-code.txt
+++ b/docs/internals/contributing/committing-code.txt
@@ -11,8 +11,8 @@ contribute code to Django, look at :doc:`writing-code/working-with-git` instead.
Handling pull requests
======================
-Since Django is now hosted at GitHub, most patches are provided in the form of
-pull requests.
+Since Django is hosted on GitHub, patches are provided in the form of pull
+requests.
When committing a pull request, make sure each individual commit matches the
commit guidelines described below. Contributors are expected to provide the
@@ -26,14 +26,14 @@ builders that doesn't run automatically, such as Oracle or Selenium. See the
.. _Jenkins wiki page: https://code.djangoproject.com/wiki/Jenkins
-An easy way to checkout a pull request locally is to add an alias to your
-``~/.gitconfig`` (``upstream`` is assumed to be ``django/django``)::
+If you find yourself checking out pull requests locally more often, this git
+alias will be helpful::
[alias]
pr = !sh -c \"git fetch upstream pull/${1}/head:pr/${1} && git checkout pr/${1}\"
-Now you can simply run ``git pr ####`` to checkout the corresponding pull
-request.
+Add it to your ``~/.gitconfig``, and set ``upstream`` to be ``django/django``.
+Then you can run ``git pr ####`` to checkout the corresponding pull request.
At this point, you can work on the code. Use ``git rebase -i`` and ``git
commit --amend`` to make sure the commits have the expected level of quality.
@@ -243,8 +243,8 @@ When a mistaken commit is discovered, please follow these guidelines:
* The release branch maintainer may back out commits to the release
branch without permission if the commit breaks the release branch.
-* If you mistakenly push a topic branch to ``django/django``, just delete it.
+* If you mistakenly push a topic branch to ``django/django``, delete it.
For instance, if you did: ``git push upstream feature_antigravity``,
- just do a reverse push: ``git push upstream :feature_antigravity``.
+ do a reverse push: ``git push upstream :feature_antigravity``.
.. _ticket tracker: https://code.djangoproject.com/