mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-12-22 22:45:09 +01:00
Update CONTRIBUTING.rst
This commit is contained in:
parent
6aa2e510a3
commit
71f82d57d9
1 changed files with 8 additions and 8 deletions
|
@ -20,15 +20,15 @@ Setting things up
|
|||
|
||||
4. Install dependencies:
|
||||
|
||||
``$ pip install -r requirements.txt``
|
||||
``$ pip install -r requirements.txt``
|
||||
|
||||
``$ pip install -r requirements-dev.txt``
|
||||
``$ pip install -r requirements-dev.txt``
|
||||
|
||||
5. In order to run tests you need to set the following environment variables:
|
||||
|
||||
``$ export CHAT_ID=your-chat-id``
|
||||
``$ export CHAT_ID=your-chat-id``
|
||||
|
||||
``$ export TOKEN=your-bot-token``
|
||||
``$ export TOKEN=your-bot-token``
|
||||
|
||||
Finding something to do
|
||||
-----------------------
|
||||
|
@ -72,13 +72,13 @@ Here's how to make a one-off code change.
|
|||
|
||||
- Before making a commit ensure that all automated tests still pass:
|
||||
|
||||
``$ make test``
|
||||
``$ make test``
|
||||
|
||||
- To actually make the commit and push it to your GitHub fork, run:
|
||||
|
||||
``$ git commit -a -m "your-commit-message-here"``
|
||||
``$ git commit -a -m "your-commit-message-here"``
|
||||
|
||||
``$ git push origin your-branch-name``
|
||||
``$ git push origin your-branch-name``
|
||||
|
||||
4. **When your feature is ready to merge, create a pull request.**
|
||||
|
||||
|
@ -127,4 +127,4 @@ Here's how to make a one-off code change.
|
|||
.. _`developers' mailing list`: mailto:devs@python-telegram-bot.org
|
||||
.. _`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
|
||||
.. _AUTHORS.rst: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/AUTHORS.rst
|
||||
|
|
Loading…
Reference in a new issue