Skip to content

Commit 74a2baf

Browse files
committed
update CONTRIBUTING guide
1 parent 0612385 commit 74a2baf

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

CONTRIBUTING.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,7 @@ Setting things up
2020

2121
4. Install dependencies:
2222

23-
``$ pip install -r requirements.txt``
24-
25-
``$ pip install -r requirements-dev.txt``
23+
``$ pip install -r requirements.txt -r requirements-dev.txt``
2624

2725
Finding something to do
2826
-----------------------
@@ -56,6 +54,8 @@ Here's how to make a one-off code change.
5654

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

57+
- Your code should adhere to the `PEP 8 Style Guide`_, with the exception that we have a maximum line length of 99.
58+
5959
- 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.
6060

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

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

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

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

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

0 commit comments

Comments
 (0)