diff --git a/docs/sphinx/source/contributing.rst b/docs/sphinx/source/contributing.rst index 5a629730af..b3c301092a 100644 --- a/docs/sphinx/source/contributing.rst +++ b/docs/sphinx/source/contributing.rst @@ -309,22 +309,22 @@ To run the tests locally, install the ``test`` dependencies specified in the file. See :ref:`installation` instructions for more information. pvlib's unit tests can easily be run by executing ``pytest`` on the -pvlib directory: +pvlib directory:: -``pytest pvlib`` + pytest pvlib -or, for a single module: +or, for a single module:: -``pytest pvlib/test/test_clearsky.py`` + pytest pvlib/test/test_clearsky.py -or, for a single test: +or, for a single test:: -``pytest pvlib/test/test_clearsky.py::test_ineichen_nans`` + pytest pvlib/test/test_clearsky.py::test_ineichen_nans We suggest using pytest's ``--pdb`` flag to debug test failures rather -than using ``print`` or ``logging`` calls. For example: +than using ``print`` or ``logging`` calls. For example:: -``pytest pvlib --pdb`` + pytest pvlib --pdb will drop you into the `pdb debugger `_ at the @@ -333,9 +333,9 @@ code does not use ``print`` or ``logging`` calls, and this also applies to the test suite (with rare exceptions). To include all network-dependent tests, include the ``--remote-data`` flag to -your ``pytest`` call: +your ``pytest`` call:: -``pytest pvlib --remote-data`` + pytest pvlib --remote-data And consider adding ``@pytest.mark.remote_data`` to any network dependent test you submit for a PR. @@ -460,3 +460,8 @@ If this documentation is unclear, help us improve it! Consider looking at the `pandas documentation `_ for inspiration. + +Code of Conduct +~~~~~~~~~~~~~~~ +All contributors are expected to adhere to the `Contributor Code of Conduct +`_. diff --git a/docs/sphinx/source/whatsnew/v0.7.2.rst b/docs/sphinx/source/whatsnew/v0.7.2.rst index 560fca4146..2c57cca492 100644 --- a/docs/sphinx/source/whatsnew/v0.7.2.rst +++ b/docs/sphinx/source/whatsnew/v0.7.2.rst @@ -58,9 +58,10 @@ Testing Documentation ~~~~~~~~~~~~~ -* Add NumFOCUS affiliation to Sphinx documentation (:pull:`862`) -* Add example of IV curve generation (:pull:`872`) -* Add section about gallery examples to Contributing guide (:pull:`905`) +* Add NumFOCUS affiliation to Sphinx documentation. (:pull:`862`) +* Add example of IV curve generation. (:pull:`872`) +* Add section about gallery examples to Contributing guide. (:pull:`905`) +* Add section with link to Code of Conduct in Contributing guide. (:pull:`922`) Requirements ~~~~~~~~~~~~