Skip to content

Commit c9929e8

Browse files
mikofskicwhanse
andauthored
Link to code of conduct (#922)
* Link to code of contact * Update docs/sphinx/source/contributing.rst Co-Authored-By: Cliff Hansen <[email protected]> * remove CoC contact proj-team and shell prompts * update what's new re: CoC link in contributing Co-authored-by: Cliff Hansen <[email protected]>
1 parent 94471fd commit c9929e8

File tree

2 files changed

+19
-13
lines changed

2 files changed

+19
-13
lines changed

docs/sphinx/source/contributing.rst

+15-10
Original file line numberDiff line numberDiff line change
@@ -309,22 +309,22 @@ To run the tests locally, install the ``test`` dependencies specified in the
309309
file. See :ref:`installation` instructions for more information.
310310

311311
pvlib's unit tests can easily be run by executing ``pytest`` on the
312-
pvlib directory:
312+
pvlib directory::
313313

314-
``pytest pvlib``
314+
pytest pvlib
315315

316-
or, for a single module:
316+
or, for a single module::
317317

318-
``pytest pvlib/test/test_clearsky.py``
318+
pytest pvlib/test/test_clearsky.py
319319

320-
or, for a single test:
320+
or, for a single test::
321321

322-
``pytest pvlib/test/test_clearsky.py::test_ineichen_nans``
322+
pytest pvlib/test/test_clearsky.py::test_ineichen_nans
323323

324324
We suggest using pytest's ``--pdb`` flag to debug test failures rather
325-
than using ``print`` or ``logging`` calls. For example:
325+
than using ``print`` or ``logging`` calls. For example::
326326

327-
``pytest pvlib --pdb``
327+
pytest pvlib --pdb
328328

329329
will drop you into the
330330
`pdb debugger <https://docs.python.org/3/library/pdb.html>`_ at the
@@ -333,9 +333,9 @@ code does not use ``print`` or ``logging`` calls, and this also applies
333333
to the test suite (with rare exceptions).
334334

335335
To include all network-dependent tests, include the ``--remote-data`` flag to
336-
your ``pytest`` call:
336+
your ``pytest`` call::
337337

338-
``pytest pvlib --remote-data``
338+
pytest pvlib --remote-data
339339

340340
And consider adding ``@pytest.mark.remote_data`` to any network dependent test
341341
you submit for a PR.
@@ -460,3 +460,8 @@ If this documentation is unclear, help us improve it! Consider looking
460460
at the `pandas
461461
documentation <http://pandas.pydata.org/pandas-docs/stable/
462462
contributing.html>`_ for inspiration.
463+
464+
Code of Conduct
465+
~~~~~~~~~~~~~~~
466+
All contributors are expected to adhere to the `Contributor Code of Conduct
467+
<https://github.com/pvlib/pvlib-python/blob/master/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct>`_.

docs/sphinx/source/whatsnew/v0.7.2.rst

+4-3
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,10 @@ Testing
6161

6262
Documentation
6363
~~~~~~~~~~~~~
64-
* Add NumFOCUS affiliation to Sphinx documentation (:pull:`862`)
65-
* Add example of IV curve generation (:pull:`872`)
66-
* Add section about gallery examples to Contributing guide (:pull:`905`)
64+
* Add NumFOCUS affiliation to Sphinx documentation. (:pull:`862`)
65+
* Add example of IV curve generation. (:pull:`872`)
66+
* Add section about gallery examples to Contributing guide. (:pull:`905`)
67+
* Add section with link to Code of Conduct in Contributing guide. (:pull:`922`)
6768

6869
Requirements
6970
~~~~~~~~~~~~

0 commit comments

Comments
 (0)