summaryrefslogtreecommitdiff
path: root/docs/internals/contributing
diff options
context:
space:
mode:
authorakki <akki@users.noreply.github.com>2016-11-16 03:30:50 +0530
committerTim Graham <timograham@gmail.com>2016-11-15 17:32:16 -0500
commitd2fc204694fa57a56da819b00a204a39eea55d82 (patch)
tree0cb600f58af809a8bc9eab7d14eb30cba9a514fb /docs/internals/contributing
parentaf0f01558bb53553a1a7cd24f8121163c0069c85 (diff)
[1.10.x] Replaced "django" with "Django" in spelling_wordlist.
Backport of 74ed20b49ade9f1cbd9af294e35478d8e0f59344 from master
Diffstat (limited to 'docs/internals/contributing')
-rw-r--r--docs/internals/contributing/committing-code.txt8
-rw-r--r--docs/internals/contributing/new-contributors.txt4
-rw-r--r--docs/internals/contributing/writing-code/working-with-git.txt10
3 files changed, 11 insertions, 11 deletions
diff --git a/docs/internals/contributing/committing-code.txt b/docs/internals/contributing/committing-code.txt
index 1e53be41f5..5bd47e8f67 100644
--- a/docs/internals/contributing/committing-code.txt
+++ b/docs/internals/contributing/committing-code.txt
@@ -106,9 +106,9 @@ Committing guidelines
In addition, please follow the following guidelines when committing code to
Django's Git repository:
-* Never change the published history of django/django branches! **Never
- force-push your changes to django/django.** If you absolutely must (for
- security reasons for example) first discuss the situation with the core team.
+* Never change the published history of ``django/django`` branches by force
+ pushing. If you absolutely must (for security reasons for example), first
+ discuss the situation with the team.
* For any medium-to-big changes, where "medium-to-big" is according to
your judgment, please bring things up on the |django-developers|
@@ -239,7 +239,7 @@ 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``, just delete it.
For instance, if you did: ``git push upstream feature_antigravity``,
just do a reverse push: ``git push upstream :feature_antigravity``.
diff --git a/docs/internals/contributing/new-contributors.txt b/docs/internals/contributing/new-contributors.txt
index a4be802909..379b0f8971 100644
--- a/docs/internals/contributing/new-contributors.txt
+++ b/docs/internals/contributing/new-contributors.txt
@@ -145,8 +145,8 @@ FAQ
First off, it's not personal. Django is entirely developed by volunteers
(even the core team), and sometimes folks just don't have time. The best
thing to do is to send a gentle reminder to the |django-developers| mailing
- list asking for review on the ticket, or to bring it up in the #django-dev
- IRC channel.
+ list asking for review on the ticket, or to bring it up in the
+ `#django-dev` IRC channel.
2. **I'm sure my ticket is absolutely 100% perfect, can I mark it as RFC
myself?**
diff --git a/docs/internals/contributing/writing-code/working-with-git.txt b/docs/internals/contributing/writing-code/working-with-git.txt
index 4bfeece755..7cea064b2a 100644
--- a/docs/internals/contributing/writing-code/working-with-git.txt
+++ b/docs/internals/contributing/writing-code/working-with-git.txt
@@ -55,8 +55,8 @@ cloned directory, so switch to it now::
Your GitHub repository will be called "origin" in Git.
-You should also setup django/django as an "upstream" remote (that is, tell git
-that the reference Django repository was the source of your fork of it)::
+You should also setup ``django/django`` as an "upstream" remote (that is, tell
+git that the reference Django repository was the source of your fork of it)::
git remote add upstream git@github.com:django/django.git
git fetch upstream
@@ -116,7 +116,7 @@ their clone would become corrupt when you edit commits.
There are also "public branches". These are branches other people are supposed
to fork, so the history of these branches should never change. Good examples
of public branches are the ``master`` and ``stable/A.B.x`` branches in the
-django/django repository.
+``django/django`` repository.
When you think your work is ready to be pulled into Django, you should create
a pull request at GitHub. A good pull request means:
@@ -193,14 +193,14 @@ a topic branch, and nobody should be basing their work on it.
After upstream has changed
--------------------------
-When upstream (django/django) has changed, you should rebase your work. To
+When upstream (``django/django``) has changed, you should rebase your work. To
do this, use::
git fetch upstream
git rebase
The work is automatically rebased using the branch you forked on, in the
-example case using upstream/master.
+example case using ``upstream/master``.
The rebase command removes all your local commits temporarily, applies the
upstream commits, and then applies your local commits again on the work.