From 623e0015b020f06560d030dc4b7f5242aca734f4 Mon Sep 17 00:00:00 2001 From: Mark Mikofski Date: Mon, 2 Mar 2020 00:49:11 -0800 Subject: [PATCH 1/4] Link to code of contact --- docs/sphinx/source/contributing.rst | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/docs/sphinx/source/contributing.rst b/docs/sphinx/source/contributing.rst index 5a629730af..14025edb6b 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,9 @@ 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 `Contrubor Code of Conduct +`_. +If anyone feels the code has been violated, they can contact the project team. From 2479dbca9f0699925457a5a60b471dd8c97685ea Mon Sep 17 00:00:00 2001 From: Mark Mikofski Date: Mon, 2 Mar 2020 10:43:51 -0800 Subject: [PATCH 2/4] Update docs/sphinx/source/contributing.rst Co-Authored-By: Cliff Hansen --- docs/sphinx/source/contributing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/contributing.rst b/docs/sphinx/source/contributing.rst index 14025edb6b..2af10a656a 100644 --- a/docs/sphinx/source/contributing.rst +++ b/docs/sphinx/source/contributing.rst @@ -463,6 +463,6 @@ contributing.html>`_ for inspiration. Code of Conduct ~~~~~~~~~~~~~~~ -All contributors are expected to adhere to the `Contrubor Code of Conduct +All contributors are expected to adhere to the `Contributor Code of Conduct `_. If anyone feels the code has been violated, they can contact the project team. From 818c1eac859804528553d89f19862d4c8825178c Mon Sep 17 00:00:00 2001 From: Mark Mikofski Date: Mon, 2 Mar 2020 12:12:56 -0800 Subject: [PATCH 3/4] remove CoC contact proj-team and shell prompts --- docs/sphinx/source/contributing.rst | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/sphinx/source/contributing.rst b/docs/sphinx/source/contributing.rst index 2af10a656a..b3c301092a 100644 --- a/docs/sphinx/source/contributing.rst +++ b/docs/sphinx/source/contributing.rst @@ -311,20 +311,20 @@ file. See :ref:`installation` instructions for more information. pvlib's unit tests can easily be run by executing ``pytest`` on the pvlib directory:: - $ pytest pvlib + pytest pvlib or, for a single module:: - $ pytest pvlib/test/test_clearsky.py + pytest pvlib/test/test_clearsky.py 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:: - $ pytest pvlib --pdb + pytest pvlib --pdb will drop you into the `pdb debugger `_ at the @@ -335,7 +335,7 @@ to the test suite (with rare exceptions). To include all network-dependent tests, include the ``--remote-data`` flag to 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. @@ -465,4 +465,3 @@ Code of Conduct ~~~~~~~~~~~~~~~ All contributors are expected to adhere to the `Contributor Code of Conduct `_. -If anyone feels the code has been violated, they can contact the project team. From c2b4fd8219621611ee1eb0fee1c971221ba36aec Mon Sep 17 00:00:00 2001 From: Mark Mikofski Date: Mon, 2 Mar 2020 12:42:54 -0800 Subject: [PATCH 4/4] update what's new re: CoC link in contributing --- docs/sphinx/source/whatsnew/v0.7.2.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) 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 ~~~~~~~~~~~~