Skip to content

Commit

Permalink
update CONTRIBUTING guide
Browse files Browse the repository at this point in the history
  • Loading branch information
rahiel committed Apr 28, 2016
1 parent 0612385 commit 74a2baf
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,7 @@ Setting things up

4. Install dependencies:

``$ pip install -r requirements.txt``

``$ pip install -r requirements-dev.txt``
``$ pip install -r requirements.txt -r requirements-dev.txt``

Finding something to do
-----------------------
Expand Down Expand Up @@ -56,6 +54,8 @@ Here's how to make a one-off code change.

- You can refer to relevant issues in the commit message by writing, e.g., "#105".

- Your code should adhere to the `PEP 8 Style Guide`_, with the exception that we have a maximum line length of 99.

- For consistency, please conform to `Google Python Style Guide`_ and `Google Python Style Docstrings`_. In addition, code should be formatted consistently with other code around it.

- The following exceptions to the above (Google's) style guides applies:
Expand Down Expand Up @@ -116,7 +116,7 @@ Here's how to make a one-off code change.

- At the end, the reviewer will merge the pull request.

6. **Tidy up!** Delete the feature branch from your both your local clone and the GitHub repository:
6. **Tidy up!** Delete the feature branch from both your local clone and the GitHub repository:

``$ git branch -D your-branch-name``

Expand All @@ -127,6 +127,7 @@ Here's how to make a one-off code change.
.. _`Code of Conduct`: https://www.python.org/psf/codeofconduct/
.. _`issue tracker`: https://github.com/python-telegram-bot/python-telegram-bot/issues
.. _`developers' mailing list`: mailto:devs@python-telegram-bot.org
.. _`PEP 8 Style Guide`: https://www.python.org/dev/peps/pep-0008/
.. _`Google Python Style Guide`: https://google-styleguide.googlecode.com/svn/trunk/pyguide.html
.. _`Google Python Style Docstrings`: http://sphinx-doc.org/latest/ext/example_google.html
.. _AUTHORS.rst: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/AUTHORS.rst

0 comments on commit 74a2baf

Please sign in to comment.