Skip to content

Commit 4297549

Browse files
committed
minor editorial updates [ci skip]
1 parent 3d8a540 commit 4297549

File tree

1 file changed

+19
-22
lines changed

1 file changed

+19
-22
lines changed

CONTRIBUTING.rst

+19-22
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,14 @@ Contributors are asked to confirm that they comply with project `license
2828
GitHub Commit Access
2929
^^^^^^^^^^^^^^^^^^^^
3030

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
4039

4140
GitHub Pull Requests
4241
^^^^^^^^^^^^^^^^^^^^
@@ -81,12 +80,12 @@ Documentation
8180
- documentation is managed in ``docs/``, in reStructuredText format
8281
- `Sphinx`_ is used to generate the documentation
8382
- See the `reStructuredText Primer <http://sphinx-doc.org/rest.html>`_ on rST
84-
markup and syntax.
83+
markup and syntax
8584

8685
Bugs
8786
----
8887

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
9089
place to report bugs or request enhancements. To submit a bug be sure to specify
9190
the PyWPS version you are using, the appropriate component, a description of how
9291
to reproduce the bug, as well as what version of Python and platform.
@@ -116,27 +115,26 @@ GitHub Commit Guidelines
116115
- Git commits shall include a description of changes
117116
- Git commits shall include the GitHub issue number (i.e. ``#1234``) in the Git
118117
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
120121
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
124123
accompanied by example WPS request XML or KVP
125124

126125
Coding Guidelines
127126
^^^^^^^^^^^^^^^^^
128127

129-
- PyWPS instead of pywps, pyWPS, Pywps
128+
- PyWPS instead of pywps, pyWPS, Pywps, PYWPS
130129
- 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
134132
specify the appropriate ``locator`` and ``code`` parameters
135133

136134
Submitting a Pull Request
137135
^^^^^^^^^^^^^^^^^^^^^^^^^
138136

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
140138
assumes you have forked PyWPS into your own GitHub repository.
141139

142140
.. code-block:: bash
@@ -185,7 +183,6 @@ master:
185183
186184
.. _`OSGeo`: http://www.osgeo.org/content/foundation/legal/licenses.html
187185
.. _`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/
190187
.. _`Sphinx`: http://sphinx-doc.org/
191188
.. _`mailing list`: http://pywps.org/community

0 commit comments

Comments
 (0)