How To Contribute

Every open source project lives from the generous help by contributors that sacrifice their time and ``python-telegram-bot`` is no different. To make participation as pleasant as possible, this project adheres to the `Code of Conduct`_ by the Python Software Foundation.

Setting things up

1. Fork the ``python-telegram-bot`` repository to your GitHub account.

Finding something to do

If you already know what you'd like to work on, you can skip this section.

Another great way to start contributing is by writing tests. Tests are really important because they help prevent developers from accidentally breaking existing code, allowing them to build cool things faster. If you're interested in helping out, let the development team know by posting to the `developers' mailing list`_, and we'll help you get started.

Instructions for making a code change

The central development branch is ``master``, which should be clean and ready for release at any time. In general, all changes should be done as feature branches based off of ``master``.

.. code-block::

- To actually make the commit (this will trigger tests for yapf, lint and pep8 automatically):

.. code-block:: bash

- If after merging you see local modified files in ``telegram/vendor/`` directory, that you didn't actually touch, that means you need to update submodules with this command:

.. code-block:: bash

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

7. **Celebrate.** Congratulations, you have contributed to ``python-telegram-bot``!

Style commandments

Specific commandments

- Avoid using "double quotes" where you can reasonably use 'single quotes'.

Properly calling callables

Methods, functions and classes can specify optional parameters (with default

values) using Python's keyword arg syntax. When providing a value to such a

to add new required arguments. It's also more explicit and easier to read.

Properly defining optional arguments

It's always good to not initialize optional arguments at class creation,

instead use ``**kwargs`` to get them. It's well known Telegram API can

files: ^telegram/.*\.py$

args:

- --errors-only

cache:

directories:

- $HOME/.cache/pip

before_cache:

- rm -f $HOME/.cache/pip/log/debug.log

install:

- pip install -U wheel

- if [[ $TRAVIS_PYTHON_VERSION != 'pypy'* ]]; then pip install ujson; fi

script:

after_success:

coveralls

.PHONY: clean pep257 pep8 yapf lint test install

PYLINT := pylint

PEP257 := pep257

PEP8 := flake8

YAPF := yapf

$(PYLINT) -E telegram --disable=no-name-in-module,import-error

test:

install:

$(PIP) install -r requirements.txt -r requirements-dev.txt

@echo "- pep8 Check style with flake8"

@echo "- lint Check style with pylint"

@echo "- yapf Check style with yapf"

@echo

@echo "Available variables:"

@echo "- PYLINT default: $(PYLINT)"

@echo "- PEP257 default: $(PEP257)"

@echo "- PEP8 default: $(PEP8)"

@echo "- YAPF default: $(YAPF)"

cache: C:\Users\appveyor\pip\wheels

test_script:

based_on_style = google

split_before_logical_operator = True

column_limit = 99

url_ = '{0}/setWebhook'.format(self.base_url)

# Backwards-compatibility: 'url' used to be named 'webhook_url'

warnings.warn("The 'webhook_url' parameter has been renamed to 'url' in accordance "

"with the API")

self.bot = bot

@classmethod

def de_json(cls, data, bot):