diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 1a7cefa8..5193be1f 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,6 +1,5 @@ -************************** How to contribute to Flask -************************** +========================== Thank you for considering contributing to Flask! @@ -15,7 +14,7 @@ Thank you for considering contributing to Flask! * `Running test coverage`_ Support questions -################# +----------------- Please don't use the issue tracker for support questions. The issue tracker is a tool to address bugs and feature requests in Flask itself. Use one of the @@ -34,7 +33,7 @@ own code: Reporting issues -################ +---------------- Include the following information in your post: @@ -52,7 +51,7 @@ Include the following information in your post: Submitting patches -################## +------------------ If there is not an open issue for what you want to submit, prefer opening one for discussion before working on a PR. You can work on any @@ -78,7 +77,7 @@ Include the following in your patch: First time setup -**************** +~~~~~~~~~~~~~~~~ - Download and install the `latest version of git`_. - Configure git with your `username`_ and `email`_. @@ -150,7 +149,7 @@ First time setup Start coding -************ +~~~~~~~~~~~~ - Create a branch to identify the issue you would like to work on. If you're submitting a bug or documentation fix, branch off of the @@ -185,7 +184,7 @@ Start coding Running the tests -***************** +~~~~~~~~~~~~~~~~~ Run the basic test suite with pytest. @@ -204,7 +203,7 @@ wait. Running test coverage -********************* +~~~~~~~~~~~~~~~~~~~~~ Generating a report of lines that do not have test coverage can indicate where to start contributing. Run ``pytest`` using ``coverage`` and @@ -222,7 +221,7 @@ Read more about `coverage `__. Building the docs -***************** +~~~~~~~~~~~~~~~~~ Build the docs in the ``docs`` directory using Sphinx.