diff options
| author | Aymeric Augustin <aymeric.augustin@m4x.org> | 2012-06-08 11:53:54 +0200 |
|---|---|---|
| committer | Aymeric Augustin <aymeric.augustin@m4x.org> | 2012-06-08 11:53:54 +0200 |
| commit | d2ad3b0f962909c14eab2ffda2fa66740f434c79 (patch) | |
| tree | cf05e95eb3ad9e831bb72611fee8d1831ba41890 | |
| parent | 1f203f84d01508345997f921bc9feed8b4ff2fc5 (diff) | |
| download | django-d2ad3b0f962909c14eab2ffda2fa66740f434c79.tar.gz | |
Clarified the purpose of the pull requsets docs
One is for the community, the other for the core team.
Thanks Reinout van Rees for the report.
| -rw-r--r-- | docs/internals/contributing/committing-code.txt | 4 | ||||
| -rw-r--r-- | docs/internals/contributing/writing-code/working-with-git.txt | 25 |
2 files changed, 19 insertions, 10 deletions
diff --git a/docs/internals/contributing/committing-code.txt b/docs/internals/contributing/committing-code.txt index a77a5762b5..a83697734a 100644 --- a/docs/internals/contributing/committing-code.txt +++ b/docs/internals/contributing/committing-code.txt @@ -3,7 +3,9 @@ Committing code =============== This section is addressed to the :doc:`/internals/committers` and to anyone -interested in knowing how code gets committed into Django core. +interested in knowing how code gets committed into Django core. If you're a +community member who wants to contribute code to Django, have a look at +:doc:`writing-code/working-with-git` instead. Commit access ------------- diff --git a/docs/internals/contributing/writing-code/working-with-git.txt b/docs/internals/contributing/writing-code/working-with-git.txt index ad03a29860..d4a95ae45a 100644 --- a/docs/internals/contributing/writing-code/working-with-git.txt +++ b/docs/internals/contributing/writing-code/working-with-git.txt @@ -1,6 +1,21 @@ Working with Git and GitHub =========================== +This section explains how the community can contribute code to Django via pull +requests. If you're interested in how core developers handle them, see +:doc:`../committing-code`. + +Below, we are going to show how to create a GitHub pull request containing the +changes for Trac ticket #xxxxx. By creating a fully-ready pull request you +will make the committers' job easier, meaning that your work is more likely to +be merged into Django. + +You could also upload a traditional patch to Trac, but it's less practical for +reviews. + +Installing Git +-------------- + Django uses `Git`_ for its source control. You can `download <http://git-scm.com/download>`_ Git, but it's often easier to install with your operating system's package manager. @@ -18,17 +33,9 @@ Note that ``user.name`` should be your real name, not your GitHub nick. GitHub should know the email you use in the ``user.email`` field, as this will be used to associate your commits with your GitHub account. -Now we are going to show how to create a GitHub pull request containing the -changes for Trac ticket #xxxxx. By creating a fully-ready pull request you -will make the committers' job easier, meaning that your work is more likely to -be merged into Django. - -You could also upload a traditional patch to Trac, but it's less practical for -reviews. - .. _Git: http://git-scm.com/ -.. _GitHub: https://github.com/ .. _Git repository: https://github.com/django/django/ +.. _GitHub: https://github.com/ Setting up local repository --------------------------- |