Skip to content

Link to code of conduct #922

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 2, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 15 additions & 10 deletions docs/sphinx/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://docs.python.org/3/library/pdb.html>`_ at the
Expand All @@ -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.
Expand Down Expand Up @@ -460,3 +460,8 @@ If this documentation is unclear, help us improve it! Consider looking
at the `pandas
documentation <http://pandas.pydata.org/pandas-docs/stable/
contributing.html>`_ for inspiration.

Code of Conduct
~~~~~~~~~~~~~~~
All contributors are expected to adhere to the `Contributor Code of Conduct
<https://github.com/pvlib/pvlib-python/blob/master/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct>`_.
7 changes: 4 additions & 3 deletions docs/sphinx/source/whatsnew/v0.7.2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
~~~~~~~~~~~~
Expand Down