From ea1614631e1d460e028fbe41000db27216fd2608 Mon Sep 17 00:00:00 2001 From: Leandro Toledo Date: Wed, 12 Aug 2015 18:57:46 -0300 Subject: [PATCH] Update and rename CONTRIBUTING to CONTRIBUTING.rst --- CONTRIBUTING | 0 CONTRIBUTING.rst | 39 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 39 insertions(+) delete mode 100644 CONTRIBUTING create mode 100644 CONTRIBUTING.rst diff --git a/CONTRIBUTING b/CONTRIBUTING deleted file mode 100644 index e69de29bb..000000000 diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 000000000..b0ca90b97 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,39 @@ +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. + +Here are a few guidelines to get you started: + +- Add yourself to the AUTHORS.rst_ file in an alphabetical fashion. + Every contribution is valuable and shall be credited. +- If your change is noteworthy, add an entry to the CHANGES_. +- No contribution is too small; please submit as many fixes for typos and grammar bloopers as you can! +- Don’t break backward compatibility. +- *Always* add tests and docs for your code. + This is a hard rule; patches with missing tests or documentation won’t be merged. + If a feature is not tested or documented, it doesn’t exist. +- Obey `PEP 8`_ and `PEP 257`_. +- Follow `Google Python Style Guide`_ and `Google Python Style Docstrings`_. +- Write `good commit messages`_. + +.. note:: + If you have something great but aren’t sure whether it adheres -- or even can adhere -- to the rules above: **please submit a pull request anyway**! + + In the best case, we can mold it into something, in the worst case the pull request gets politely closed. + There’s absolutely nothing to fear. + +Thank you for considering to contribute to ``python-telegram-bot``! +If you have any question or concerns, feel free to reach out to me. + + +.. _`PEP 8`: https://www.python.org/dev/peps/pep-0008/ +.. _`PEP 257`: https://www.python.org/dev/peps/pep-0257/ +.. _`good commit messages`: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html +.. _`Code of Conduct`: https://www.python.org/psf/codeofconduct/ +.. _`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 +.. _CHANGES: https://github.com/leandrotoledo/python-telegram-bot/blob/master/CHANGES +.. _AUTHORS.rst: https://github.com/leandrotoledo/python-telegram-bot/blob/master/AUTHORS.rst