You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -45,7 +32,7 @@ framework integration as a separate package and add it to the
45
32
the `GitHub wiki <https://github.com/marshmallow-code/webargs/wiki/Ecosystem>`_ .
46
33
47
34
Setting Up for Local Development
48
-
********************************
35
+
++++++++++++++++++++++++++++++++
49
36
50
37
1. Fork webargs_ on GitHub.
51
38
@@ -72,10 +59,11 @@ Setting Up for Local Development
72
59
73
60
.. note::
74
61
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.
76
64
77
65
Git Branch Structure
78
-
********************
66
+
++++++++++++++++++++
79
67
80
68
Webargs abides by the following branching model:
81
69
@@ -89,7 +77,7 @@ Webargs abides by the following branching model:
89
77
**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.
90
78
91
79
Pull Requests
92
-
**************
80
+
++++++++++++++
93
81
94
82
1. Create a new local branch.
95
83
@@ -117,7 +105,7 @@ Pull Requests
117
105
The `CI <https://dev.azure.com/sloria/sloria/_build/latest?definitionId=6&branchName=dev>`_ build must be passing before your pull request is merged.
118
106
119
107
Running Tests
120
-
*************
108
+
+++++++++++++
121
109
122
110
To run all tests: ::
123
111
@@ -127,12 +115,12 @@ To run syntax checks: ::
127
115
128
116
$ tox -e lint
129
117
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): ::
131
119
132
120
$ tox
133
121
134
122
Documentation
135
-
*************
123
+
+++++++++++++
136
124
137
125
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_.
138
126
@@ -143,7 +131,7 @@ To build the docs in "watch" mode: ::
143
131
Changes in the `docs/` directory will automatically trigger a rebuild.
144
132
145
133
Contributing Examples
146
-
*********************
134
+
+++++++++++++++++++++
147
135
148
136
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.
0 commit comments