diff options
| author | Kenneth Reitz <me@kennethreitz.org> | 2016-02-19 03:47:12 -0500 |
|---|---|---|
| committer | Kenneth Reitz <me@kennethreitz.org> | 2016-02-19 03:47:12 -0500 |
| commit | 688a00c38643f55df41f8337b063ba1944f33ca6 (patch) | |
| tree | 2599aa27f92d549616c89f4a53e477f8ae5fa434 /docs/dev | |
| parent | f63106005b3050b5a99833ec47b78667dc4766b2 (diff) | |
| download | python-requests-688a00c38643f55df41f8337b063ba1944f33ca6.tar.gz | |
improve contributions section
Diffstat (limited to 'docs/dev')
| -rw-r--r-- | docs/dev/contributing.rst | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/docs/dev/contributing.rst b/docs/dev/contributing.rst index 075d042a..f619e569 100644 --- a/docs/dev/contributing.rst +++ b/docs/dev/contributing.rst @@ -22,12 +22,8 @@ contributors. .. _Ian Cordasco: http://www.coglib.com/~icordasc/ .. _Cory Benfield: https://lukasa.co.uk/about - -All Contributions ------------------ - Be Cordial -~~~~~~~~~~ +---------- **Be cordial or be on your way.** @@ -41,7 +37,7 @@ everyone involved is treated with respect. .. _early-feedback: Get Early Feedback -~~~~~~~~~~~~~~~~~~ +------------------ If you are contributing, do not feel the need to sit on your contribution until it is perfectly polished and complete. It helps everyone involved for you to @@ -51,7 +47,7 @@ getting that contribution accepted, and can save you from putting a lot of work into a contribution that is not suitable for the project. Contribution Suitability -~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------ The project maintainer has the last word on whether or not a contribution is suitable for Requests. All contributions will be considered, but from time @@ -116,6 +112,9 @@ When contributing documentation, please attempt to follow the style of the documentation files. This means a soft-limit of 79 characters wide in your text files and a semi-formal prose style. +When presenting Python code, use single-quoted strings (``'hello'`` instead of +``"hello"``). + .. _reStructuredText: http://docutils.sourceforge.net/rst.html .. _Sphinx: http://sphinx-doc.org/index.html |
