Skip to content

Commit 0fd8007

Browse files
committedSep 14, 2019
Update contributing guidelines
1 parent b0dbb5c commit 0fd8007

File tree

2 files changed

+11
-22
lines changed

2 files changed

+11
-22
lines changed
 

‎CONTRIBUTING.rst

+10-22
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,8 @@ Questions, Feature Requests, Bug Reports, and Feedback…
1919
Contributing Code
2020
-----------------
2121

22-
In General
23-
++++++++++
24-
25-
- `PEP 8`_, when sensible.
26-
- Test ruthlessly. Write docs for new features.
27-
- Even more important than Test-Driven Development--*Human-Driven Development*.
28-
29-
.. _`PEP 8`: http://www.python.org/dev/peps/pep-0008/
30-
31-
In Particular
32-
+++++++++++++
33-
34-
3522
Integration with a Another Web Framework…
36-
*****************************************
23+
+++++++++++++++++++++++++++++++++++++++++
3724

3825
…should be released as a separate package.
3926

@@ -45,7 +32,7 @@ framework integration as a separate package and add it to the
4532
the `GitHub wiki <https://github.com/marshmallow-code/webargs/wiki/Ecosystem>`_ .
4633

4734
Setting Up for Local Development
48-
********************************
35+
++++++++++++++++++++++++++++++++
4936

5037
1. Fork webargs_ on GitHub.
5138

@@ -72,10 +59,11 @@ Setting Up for Local Development
7259

7360
.. note::
7461

75-
webargs uses `black <https://github.com/ambv/black>`_ for code formatting, which is only compatible with Python>=3.6. Therefore, the ``pre-commit install`` command will only work if you have the ``python3.6`` interpreter installed.
62+
webargs uses `black <https://github.com/ambv/black>`_ for code formatting, which is only compatible with Python>=3.6.
63+
Therefore, the pre-commit hooks require a minimum Python version of 3.6.
7664

7765
Git Branch Structure
78-
********************
66+
++++++++++++++++++++
7967

8068
Webargs abides by the following branching model:
8169

@@ -89,7 +77,7 @@ Webargs abides by the following branching model:
8977
**Always make a new branch for your work**, no matter how small. Also, **do not put unrelated changes in the same branch or pull request**. This makes it more difficult to merge your changes.
9078

9179
Pull Requests
92-
**************
80+
++++++++++++++
9381

9482
1. Create a new local branch.
9583

@@ -117,7 +105,7 @@ Pull Requests
117105
The `CI <https://dev.azure.com/sloria/sloria/_build/latest?definitionId=6&branchName=dev>`_ build must be passing before your pull request is merged.
118106

119107
Running Tests
120-
*************
108+
+++++++++++++
121109

122110
To run all tests: ::
123111

@@ -127,12 +115,12 @@ To run syntax checks: ::
127115

128116
$ tox -e lint
129117

130-
(Optional) To run tests on Python 2.7, 3.5, 3.6, and 3.7 virtual environments (must have each interpreter installed): ::
118+
(Optional) To run tests in all supported Python versions in their own virtual environments (must have each interpreter installed): ::
131119

132120
$ tox
133121

134122
Documentation
135-
*************
123+
+++++++++++++
136124

137125
Contributions to the documentation are welcome. Documentation is written in `reStructured Text`_ (rST). A quick rST reference can be found `here <http://docutils.sourceforge.net/docs/user/rst/quickref.html>`_. Builds are powered by Sphinx_.
138126

@@ -143,7 +131,7 @@ To build the docs in "watch" mode: ::
143131
Changes in the `docs/` directory will automatically trigger a rebuild.
144132

145133
Contributing Examples
146-
*********************
134+
+++++++++++++++++++++
147135

148136
Have a usage example you'd like to share? Feel free to add it to the `examples <https://github.com/marshmallow-code/webargs/tree/dev/examples>`_ directory and send a pull request.
149137

‎README.rst

+1
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ Project Links
103103

104104
- Docs: https://webargs.readthedocs.io/
105105
- Changelog: https://webargs.readthedocs.io/en/latest/changelog.html
106+
- Contributing Guidelines: https://webargs.readthedocs.io/en/latest/contributing.html
106107
- PyPI: https://pypi.python.org/pypi/webargs
107108
- Issues: https://github.com/marshmallow-code/webargs/issues
108109

0 commit comments

Comments
 (0)