diff options
| author | Sviatoslav Sydorenko <wk@sydorenko.org.ua> | 2017-01-19 13:36:26 +0200 |
|---|---|---|
| committer | Sviatoslav Sydorenko <wk@sydorenko.org.ua> | 2017-01-19 13:36:26 +0200 |
| commit | 6c55e2d2bead95b67ecbb1696a57c2f5e806f018 (patch) | |
| tree | 6cae92321c9027503e68475fad88c4efaa50b316 /.github | |
| parent | eca1b40cf8d8fe279e09569e71111d781c6e1732 (diff) | |
| download | cherrypy-git-6c55e2d2bead95b67ecbb1696a57c2f5e806f018.tar.gz | |
Improve RST formatting in CONTRIBUTING guidelines
Diffstat (limited to '.github')
| -rw-r--r-- | .github/CONTRIBUTING.rst | 20 |
1 files changed, 15 insertions, 5 deletions
diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst index 2156166d..427ee4c9 100644 --- a/.github/CONTRIBUTING.rst +++ b/.github/CONTRIBUTING.rst @@ -1,18 +1,28 @@ Read and contribute to CherryPy ------------------------------- -Make sure you read the [README](https://github.com/cherrypy/cherrypy/blob/master/README.rst). Also **ensure you set up pre-commit utility correctly** and TravisCI tests pass. +Make sure you read the `README +<https://github.com/cherrypy/cherrypy/blob/master/README.rst>`_. Also **ensure +you set up pre-commit utility correctly** and TravisCI tests pass. Submitting Pull Requests ------------------------ -If you're changing the structure of the repository please create an issue first. Don't forget to write appropriate test cases, add them into CI process if applicable and make the TravisCI build pass. -Sync (preferably rebase) your feature branch with upstream regularly to make us able to merge your PR seamlessly. +If you're changing the structure of the repository please create an issue +first. Don't forget to write appropriate test cases, add them into CI process +if applicable and make the TravisCI build pass. + +Sync (preferably rebase) your feature branch with upstream regularly to make +us able to merge your PR seamlessly. Submitting bug reports ---------------------- -Make sure you are on latest changes and that you re-ran this command `tox` after updating your local repository. If you can, please provide more information about your environment such as browser, operating system, python version, and any other related software versions. +Make sure you are on latest changes and that you re-ran this command `tox` +after updating your local repository. If you can, please provide more +information about your environment such as browser, operating system, +python version, and any other related software versions. Also ---- -See `Contributing <http://docs.cherrypy.org/en/latest/contribute.html>`_ in the docs. +See `Contributing <http://docs.cherrypy.org/en/latest/contribute.html>`_ in +the docs. |