Skip to content

Commit cf49dea

Browse files
RDaxinicwhanse
andauthored
Update contributing guidelines (#2726)
* Update introduction_to_contributing.rst * order/formatting * typos * Update introduction_to_contributing.rst * Apply suggestions from code review Co-authored-by: Cliff Hansen <cwhanse@sandia.gov> * formatting, whatsnew, section reference * fix section reference link in whatsnew * Update introduction_to_contributing.rst * forgot to delete "significant" somehow? --------- Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
1 parent ea25214 commit cf49dea

2 files changed

Lines changed: 23 additions & 0 deletions

File tree

docs/sphinx/source/contributing/introduction_to_contributing.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,27 @@ contributors from novice to expert. Don't worry if you don't (yet)
1212
understand parts of it.
1313

1414

15+
.. _core-guidelines:
16+
17+
Core guidelines
18+
~~~~~~~~~~~~~~~
19+
While we welcome new contributors, reviewer capacity is limited. Therefore,
20+
following these core guidelines is essential:
21+
22+
* Pull requests (PRs) should address one or more open issues. Context should
23+
be provided, e.g. a link to the relevant discussion.
24+
* GSoC: For Google Summer of Code, we invite applications only from those with
25+
PV modeling experience and who are motivated to join the pvlib maintenance
26+
team.
27+
* pvlib-python is an advanced scientific modeling toolbox. A background
28+
in solar energy and/or experience in pvlib-python is required to
29+
address some issues effectively. It is not always clear which issues
30+
fall into this bucket. Don't be offended if maintainers close your PR for
31+
this reason.
32+
* Maintainers reserve the right to close PRs that do not comply with the
33+
contributing guidelines.
34+
35+
1536
.. _easy-ways-to-contribute:
1637

1738
Easy ways to contribute

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ Documentation
5959
* Fix a broken docstring reference to ``grounddiffuse`` in
6060
:py:func:`pvlib.irradiance.poa_components`
6161
(:issue:`2089`, :pull:`2708`)
62+
* Add :ref:`core-guidelines` to the :ref:`introduction-to-contributing` page.
63+
(:issue:`2716`, :pull:`2726`)
6264

6365

6466
Testing

0 commit comments

Comments
 (0)