Hopiu/django-admin2
1
0
Fork 0
mirror of https://github.com/jazzband/django-admin2.git synced 2026-04-20 14:51:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Match master to develop

Browse source
This commit is contained in:
Daniel Greenfeld 2013-05-21 12:45:10 +03:00
parent 55168a0ea0
commit a437aceee9
1 changed files with 18 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
docs/contributing.rst
View file

@ -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/
@ -151,10 +153,10 @@ django-admin2 pull requests should be as small/atomic as possible. Large, wide-s
#. If you are fixing a view don't '*cleanup*' unrelated views. That cleanup belongs in another pull request.
#. Changing permissions on a file should be in its own pull request with explicit reasons why.
Follow PEP-8 and keep your code simple!
---------------------------------------
Best Practices
--------------
Memorize the Zen of Python::
Follow PEP-0008 and memorize the Zen of Python::
>>> python -c 'import this'
@ -166,6 +168,11 @@ Furthermore, the pixel shortage is over. We want to see:
* `grid` instead of `g`
* `my_function_that_does_things` instead of `mftdt`
As much as possible, we follow the advice of the `Two Scoops of Django`_ book. Periodically the book will be referenced either for best practices or as a blunt object by the project lead in order to end bike-shedding.
.. _`Two Scoops of Django`: https://2scoops.org
How pull requests are checked, tested, and done
===============================================
@ -181,11 +188,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 <branch-name>
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