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 /docs/internals/contributing/writing-code/working-with-git.txt | |
| parent | 1f203f84d01508345997f921bc9feed8b4ff2fc5 (diff) | |
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.
Diffstat (limited to 'docs/internals/contributing/writing-code/working-with-git.txt')
| -rw-r--r-- | docs/internals/contributing/writing-code/working-with-git.txt | 25 |
1 files changed, 16 insertions, 9 deletions
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 --------------------------- |