python-telegram-bot · Bibo-Joshi · May 6, 2022 · Apr 24, 2022 · Apr 24, 2022 · Apr 24, 2022
diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst
@@ -1,10 +1,11 @@
+=================
 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.
 
@@ -35,18 +36,18 @@ Setting things up
       $ pre-commit install
 
 Finding something to do
-#######################
+=======================
 
 If you already know what you'd like to work on, you can skip this section.
 
 If you have an idea for something to do, first check if it's already been filed on the `issue tracker`_. If so, add a comment to the issue saying you'd like to work on it, and we'll help you get started! Otherwise, please file a new issue and assign yourself to it.
 
-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 `Telegram group`_ (use `@admins` to mention the maintainers), and we'll help you get started.
+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 `Telegram group`_, and we'll help you get started.
 
 That being said, we want to mention that we are very hesitant about adding new requirements to our projects. If you intend to do this, please state this in an issue and get a verification from one of the maintainers.
 
 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``.
 
@@ -93,21 +94,21 @@ Here's how to make a one-off code change.
 
    - Before making a commit ensure that all automated tests still pass:
 
-     .. code-block::
+     .. code-block:: bash
 
         $ pytest -v
 
      To run ``test_official`` (particularly useful if you made API changes), run
 
-     .. code-block::
+     .. code-block:: bash
 
         $ export TEST_OFFICIAL=true
 
      prior to running the tests.
 
    - If you want run style & type checks before committing run
 
-     .. code-block::
+     .. code-block:: bash
 
         $ pre-commit run -a
 
@@ -208,10 +209,10 @@ for new to make relevant changes if said lines don't do what they are supposed t
 
 
 Style commandments
-------------------
+==================
 
 Assert comparison order
-#######################
+-----------------------
 
 Assert statements should compare in **actual** == **expected** order.
 For example (assuming ``test_call`` is the thing being tested):
@@ -225,7 +226,7 @@ For example (assuming ``test_call`` is the thing being tested):
     assert 5 == test_call()
 
 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
@@ -243,7 +244,7 @@ This gives us the flexibility to re-order arguments and more importantly
 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

diff --git a/CODE_OF_CONDUCT.md → CODE_OF_CONDUCT.rst b/CODE_OF_CONDUCT.md → CODE_OF_CONDUCT.rst
@@ -1,10 +1,14 @@
-# Contributor Covenant Code of Conduct
+====================================
+Contributor Covenant Code of Conduct
+====================================
 
-## Our Pledge
+Our Pledge
+==========
 
 In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
 
-## Our Standards
+Our Standards
+=============
 
 Examples of behavior that contributes to creating a positive environment include:
 
@@ -23,25 +27,26 @@ Examples of unacceptable behavior by participants include:
 * Publishing others' private information, such as a physical or electronic address, without explicit permission
 * Other conduct which could reasonably be considered inappropriate in a professional setting
 
-## Our Responsibilities
+Our Responsibilities
+====================
 
 Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
 
 Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
 
-## Scope
+Scope
+=====
 
 This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
 
-## Enforcement
+Enforcement
+===========
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at devs@python-telegram-bot.org. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
 
-## Attribution
+Attribution
+===========
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+This Code of Conduct is adapted from the `Contributor Covenant <http://contributor-covenant.org>`_, version 1.4, available at `http://contributor-covenant.org/version/1/4 <http://contributor-covenant.org/version/1/4/>`_.