@@ -28,15 +28,14 @@ Contributors are asked to confirm that they comply with project `license
28
28
GitHub Commit Access
29
29
^^^^^^^^^^^^^^^^^^^^
30
30
31
- Proposals to provide developers with GitHub commit access shall be emailed to
32
- the pywps-devel `mailing list `_. Proposals shall be approved by the PyWPS
33
- development team. Committers shall be added by the project admin - removal of
34
- commit access shall be handled in the same manner - each committer must send
35
- an email to the PyWPS mailing list agreeing to the license guidelines (see
36
- `Contributions and Licensing Agreement Template
37
- <#contributions-and-licensing-agreement-template> `_). **This is only required
38
- once ** - each committer shall be listed in
39
- https://github.com/geopython/pywps/blob/master/COMMITTERS.txt
31
+ - proposals to provide developers with GitHub commit access shall be emailed to
32
+ the pywps-devel `mailing list `_. Proposals shall be approved by the PyWPS
33
+ development team. Committers shall be added by the project admin
34
+ - removal of commit access shall be handled in the same manner
35
+ - each committer must send an email to the PyWPS mailing list agreeing to the license guidelines (see
36
+ `Contributions and Licensing Agreement Template
37
+ <#contributions-and-licensing-agreement-template> `_). **This is only required once **
38
+ - each committer shall be listed in https://github.com/geopython/pywps/blob/master/COMMITTERS.txt
40
39
41
40
GitHub Pull Requests
42
41
^^^^^^^^^^^^^^^^^^^^
@@ -81,12 +80,12 @@ Documentation
81
80
- documentation is managed in ``docs/ ``, in reStructuredText format
82
81
- `Sphinx `_ is used to generate the documentation
83
82
- See the `reStructuredText Primer <http://sphinx-doc.org/rest.html >`_ on rST
84
- markup and syntax.
83
+ markup and syntax
85
84
86
85
Bugs
87
86
----
88
87
89
- PyWPS's `issue tracker <https://github.com/geopython/pywps/issues >`_ is the
88
+ PyWPS' `issue tracker <https://github.com/geopython/pywps/issues >`_ is the
90
89
place to report bugs or request enhancements. To submit a bug be sure to specify
91
90
the PyWPS version you are using, the appropriate component, a description of how
92
91
to reproduce the bug, as well as what version of Python and platform.
@@ -116,27 +115,26 @@ GitHub Commit Guidelines
116
115
- Git commits shall include a description of changes
117
116
- Git commits shall include the GitHub issue number (i.e. ``#1234 ``) in the Git
118
117
commit log message
119
- - all enhancements or bug fixes must successfully pass all :ref: `ogc-cite ` tests
118
+ - all enhancements or bug fixes must successfully pass all
119
+ `OGC CITE <http://cite.opengeospatial.org >`_ tests before they are committed
120
+ - all enhancements or bug fixes must successfully pass all tests
120
121
before they are committed
121
- - all enhancements or bug fixes must successfully pass all :ref: `tests ` tests
122
- before they are committed
123
- - enhancements which can be demonstrated from the PyWPS :ref: `tests ` should be
122
+ - enhancements which can be demonstrated from the PyWPS tests should be
124
123
accompanied by example WPS request XML or KVP
125
124
126
125
Coding Guidelines
127
126
^^^^^^^^^^^^^^^^^
128
127
129
- - PyWPS instead of pywps, pyWPS, Pywps
128
+ - PyWPS instead of pywps, pyWPS, Pywps, PYWPS
130
129
- always code with `PEP 8 `_ conventions
131
- - always run source code through ``pep8 `` and `pylint `_, using all pylint
132
- defaults except for ``C0111 ``. Use ``autopep `` script for automatic fixing.
133
- - for exceptions which make their way to OGC ``ExceptionReport `` XML, always
130
+ - always run source code through ``flake8 ``
131
+ - for exceptions which make their way to OGC ``ows:ExceptionReport `` XML, always
134
132
specify the appropriate ``locator `` and ``code `` parameters
135
133
136
134
Submitting a Pull Request
137
135
^^^^^^^^^^^^^^^^^^^^^^^^^
138
136
139
- This section will guide you through steps of working on . This section
137
+ This section will guide you through steps of working on PyWPS . This section
140
138
assumes you have forked PyWPS into your own GitHub repository.
141
139
142
140
.. code-block :: bash
@@ -185,7 +183,6 @@ master:
185
183
186
184
.. _`OSGeo` : http://www.osgeo.org/content/foundation/legal/licenses.html
187
185
.. _`PEP 8` : http://www.python.org/dev/peps/pep-0008/
188
- .. _`pep8` : http://pypi.python.org/pypi/pep8/
189
- .. _`pylint` : http://www.logilab.org/857
186
+ .. _`flake8` : https://flake8.readthedocs.org/en/latest/
190
187
.. _`Sphinx` : http://sphinx-doc.org/
191
188
.. _`mailing list` : http://pywps.org/community
0 commit comments