diff --git a/docs/contributing.rst b/docs/contributing.rst index 75bef9c..eea02a1 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -46,6 +46,8 @@ Tips Setting up topic branches and generating pull requests ====================================================== +.. note:: This is our way of describing our version of git-flow. + While it's handy to provide useful code snippets in an issue, it is better for you as a developer to submit pull requests. By submitting pull request your contribution to django-admin2 will be recorded by Github. @@ -72,7 +74,7 @@ To create a topic branch, its easiest to use the convenient ``-b`` argument to ` You should use a verbose enough name for your branch so it is clear what it is about. Now you can commit your changes and regularly merge in the upstream -master as described below. +develop as described below. When you are ready to generate a pull request, either for preliminary review, or for consideration of merging into the project you must first push your local @@ -101,16 +103,16 @@ Pull upstream changes into your fork regularly To pull in upstream changes:: - git remote add upstream https://github.com/pydanny/django-admin2.git + git remote add upstream https://github.com/twoscoops/django-admin2.git git fetch upstream Check the log to be sure that you actually want the changes, before merging:: - git log upstream/master + git log upstream/develop Then merge the changes that you fetched:: - git merge upstream/master + git merge upstream/develop For more info, see http://help.github.com/fork-a-repo/ @@ -181,11 +183,11 @@ Then we run the tests:: We finish with a non-fastforward merge (to preserve the branch history) and push to GitHub:: - git checkout master + git checkout develop git merge --no-ff - git push upstream master + git push upstream develop .. _installation: install.html -.. _GitHub project: https://github.com/pydanny/django-admin2 -.. _issue tracker: https://github.com/pydanny/django-admin2/issues +.. _GitHub project: https://github.com/twoscoops/django-admin2 +.. _issue tracker: https://github.com/twoscoops/django-admin2/issues .. _pydanny: http://pydanny.com