From 35c5b3d133361ffe87b652fbc62bd870a4d8a777 Mon Sep 17 00:00:00 2001 From: RDaxini Date: Mon, 30 Mar 2026 13:35:15 -0600 Subject: [PATCH 1/7] Update introduction_to_contributing.rst --- .../introduction_to_contributing.rst | 26 +++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/docs/sphinx/source/contributing/introduction_to_contributing.rst b/docs/sphinx/source/contributing/introduction_to_contributing.rst index 0eb9d97e4b..024839d5b8 100644 --- a/docs/sphinx/source/contributing/introduction_to_contributing.rst +++ b/docs/sphinx/source/contributing/introduction_to_contributing.rst @@ -12,6 +12,32 @@ contributors from novice to expert. Don't worry if you don't (yet) understand parts of it. +.. _core-principles: + +Core principles +~~~~~~~~~~~~~~~ +Some core guidelines on the package, requirements for contributors, and the +practices and management of contributions. + +* pvlib-python is an advanced scientific modeling toolbox. +* Every pull request (PR) should address one or more open issues. The PR should + be outlined in the issue discussion. +* Maintainers reserve the right to close PRs that do not comply with the + contributing guidelines. +* GSoC: For Google Summer of Code, we invite applications only from those with + significnat PV modeling experience and who are motivated to join the pvlib + maintainance teams +* A background in solar energy and/or experience in pvlib python + is required to effectively address some issues due to subtleties that are hard + to appreciate until struggling with an implementation. It is not always clear + which issues fall into this bucket. Don't be offended if maintainers close your + PR for this reason. + +While we welcome new contributors, reviewer capacity is limited. Therefore, +following the guidelines above throughout in the contributing process is +critical. Since + + .. _easy-ways-to-contribute: Easy ways to contribute From da18071eb1f4cf971cd412ba70707ea653f795e3 Mon Sep 17 00:00:00 2001 From: RDaxini Date: Mon, 30 Mar 2026 13:38:01 -0600 Subject: [PATCH 2/7] order/formatting --- .../introduction_to_contributing.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/sphinx/source/contributing/introduction_to_contributing.rst b/docs/sphinx/source/contributing/introduction_to_contributing.rst index 024839d5b8..bb45e75c24 100644 --- a/docs/sphinx/source/contributing/introduction_to_contributing.rst +++ b/docs/sphinx/source/contributing/introduction_to_contributing.rst @@ -17,21 +17,21 @@ understand parts of it. Core principles ~~~~~~~~~~~~~~~ Some core guidelines on the package, requirements for contributors, and the -practices and management of contributions. +management of contributions are as follows: * pvlib-python is an advanced scientific modeling toolbox. * Every pull request (PR) should address one or more open issues. The PR should be outlined in the issue discussion. -* Maintainers reserve the right to close PRs that do not comply with the - contributing guidelines. * GSoC: For Google Summer of Code, we invite applications only from those with significnat PV modeling experience and who are motivated to join the pvlib maintainance teams -* A background in solar energy and/or experience in pvlib python - is required to effectively address some issues due to subtleties that are hard - to appreciate until struggling with an implementation. It is not always clear - which issues fall into this bucket. Don't be offended if maintainers close your - PR for this reason. +* A background in solar energy and/or experience in pvlib python is required to + effectively address some issues due to subtleties that are hard to appreciate + until struggling with an implementation. It is not always clear which issues + fall into this bucket. Don't be offended if maintainers close your PR for + this reason. +* Maintainers reserve the right to close PRs that do not comply with the + contributing guidelines. While we welcome new contributors, reviewer capacity is limited. Therefore, following the guidelines above throughout in the contributing process is From 14e1c0a6f9e5140294ec576285f853ec2ca4c25c Mon Sep 17 00:00:00 2001 From: RDaxini Date: Mon, 30 Mar 2026 13:48:40 -0600 Subject: [PATCH 3/7] typos --- .../source/contributing/introduction_to_contributing.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/sphinx/source/contributing/introduction_to_contributing.rst b/docs/sphinx/source/contributing/introduction_to_contributing.rst index bb45e75c24..259b202ac0 100644 --- a/docs/sphinx/source/contributing/introduction_to_contributing.rst +++ b/docs/sphinx/source/contributing/introduction_to_contributing.rst @@ -23,10 +23,10 @@ management of contributions are as follows: * Every pull request (PR) should address one or more open issues. The PR should be outlined in the issue discussion. * GSoC: For Google Summer of Code, we invite applications only from those with - significnat PV modeling experience and who are motivated to join the pvlib - maintainance teams + significant PV modeling experience and who are motivated to join the pvlib + maintenance teams * A background in solar energy and/or experience in pvlib python is required to - effectively address some issues due to subtleties that are hard to appreciate + address some issues effectively due to subtleties that are hard to appreciate until struggling with an implementation. It is not always clear which issues fall into this bucket. Don't be offended if maintainers close your PR for this reason. @@ -34,8 +34,7 @@ management of contributions are as follows: contributing guidelines. While we welcome new contributors, reviewer capacity is limited. Therefore, -following the guidelines above throughout in the contributing process is -critical. Since +following the guidelines above throughout the contributing process is critical. .. _easy-ways-to-contribute: From 8fb6fab4f6c4371f4407ffdf36faa3c465fb6297 Mon Sep 17 00:00:00 2001 From: RDaxini Date: Mon, 30 Mar 2026 14:07:12 -0600 Subject: [PATCH 4/7] Update introduction_to_contributing.rst --- .../sphinx/source/contributing/introduction_to_contributing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/contributing/introduction_to_contributing.rst b/docs/sphinx/source/contributing/introduction_to_contributing.rst index 259b202ac0..89fa179b70 100644 --- a/docs/sphinx/source/contributing/introduction_to_contributing.rst +++ b/docs/sphinx/source/contributing/introduction_to_contributing.rst @@ -25,7 +25,7 @@ management of contributions are as follows: * GSoC: For Google Summer of Code, we invite applications only from those with significant PV modeling experience and who are motivated to join the pvlib maintenance teams -* A background in solar energy and/or experience in pvlib python is required to +* A background in solar energy and/or experience in pvlib-python is required to address some issues effectively due to subtleties that are hard to appreciate until struggling with an implementation. It is not always clear which issues fall into this bucket. Don't be offended if maintainers close your PR for From a1f7e40474ca5844aa6bce318e10fbd925a8ba78 Mon Sep 17 00:00:00 2001 From: Rajiv Daxini <143435106+RDaxini@users.noreply.github.com> Date: Mon, 30 Mar 2026 14:40:49 -0600 Subject: [PATCH 5/7] Apply suggestions from code review Co-authored-by: Cliff Hansen --- .../contributing/introduction_to_contributing.rst | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/docs/sphinx/source/contributing/introduction_to_contributing.rst b/docs/sphinx/source/contributing/introduction_to_contributing.rst index 89fa179b70..7d46c016cb 100644 --- a/docs/sphinx/source/contributing/introduction_to_contributing.rst +++ b/docs/sphinx/source/contributing/introduction_to_contributing.rst @@ -14,27 +14,23 @@ understand parts of it. .. _core-principles: -Core principles +Core guidelines ~~~~~~~~~~~~~~~ -Some core guidelines on the package, requirements for contributors, and the -management of contributions are as follows: +While we welcome new contributors, reviewer capacity is limited. Therefore, following these core guidelines is essential: -* pvlib-python is an advanced scientific modeling toolbox. * Every pull request (PR) should address one or more open issues. The PR should be outlined in the issue discussion. * GSoC: For Google Summer of Code, we invite applications only from those with significant PV modeling experience and who are motivated to join the pvlib maintenance teams -* A background in solar energy and/or experience in pvlib-python is required to - address some issues effectively due to subtleties that are hard to appreciate - until struggling with an implementation. It is not always clear which issues +* pvlib-python is an advanced scientific modeling toolbox. A background + in solar energy and/or experience in pvlib-python is required to + address some issues effectively. It is not always clear which issues fall into this bucket. Don't be offended if maintainers close your PR for this reason. * Maintainers reserve the right to close PRs that do not comply with the contributing guidelines. -While we welcome new contributors, reviewer capacity is limited. Therefore, -following the guidelines above throughout the contributing process is critical. .. _easy-ways-to-contribute: From 50046fa34afd6f280f7260a0b83bb72091366096 Mon Sep 17 00:00:00 2001 From: RDaxini Date: Mon, 30 Mar 2026 14:55:34 -0600 Subject: [PATCH 6/7] formatting, whatsnew, section reference --- .../source/contributing/introduction_to_contributing.rst | 6 +++--- docs/sphinx/source/whatsnew/v0.15.1.rst | 2 ++ 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/sphinx/source/contributing/introduction_to_contributing.rst b/docs/sphinx/source/contributing/introduction_to_contributing.rst index 7d46c016cb..f2d262991d 100644 --- a/docs/sphinx/source/contributing/introduction_to_contributing.rst +++ b/docs/sphinx/source/contributing/introduction_to_contributing.rst @@ -12,11 +12,12 @@ contributors from novice to expert. Don't worry if you don't (yet) understand parts of it. -.. _core-principles: +.. _core-guidelines: Core guidelines ~~~~~~~~~~~~~~~ -While we welcome new contributors, reviewer capacity is limited. Therefore, following these core guidelines is essential: +While we welcome new contributors, reviewer capacity is limited. Therefore, +following these core guidelines is essential: * Every pull request (PR) should address one or more open issues. The PR should be outlined in the issue discussion. @@ -32,7 +33,6 @@ While we welcome new contributors, reviewer capacity is limited. Therefore, foll contributing guidelines. - .. _easy-ways-to-contribute: Easy ways to contribute diff --git a/docs/sphinx/source/whatsnew/v0.15.1.rst b/docs/sphinx/source/whatsnew/v0.15.1.rst index 75ab242c94..3f7a1a7efa 100644 --- a/docs/sphinx/source/whatsnew/v0.15.1.rst +++ b/docs/sphinx/source/whatsnew/v0.15.1.rst @@ -53,6 +53,8 @@ Documentation * Fix a broken docstring reference to ``grounddiffuse`` in :py:func:`pvlib.irradiance.poa_components` (:issue:`2089`, :pull:`2708`) +* Add :ref:`core-guidelines` to the :ref:`_introduction-to-contributing` page. + (:issue:`2716`, :pull:`2726`) Testing From fc2329936fb4a464b35516150eaaf342961e325c Mon Sep 17 00:00:00 2001 From: RDaxini Date: Mon, 30 Mar 2026 15:10:33 -0600 Subject: [PATCH 7/7] fix section reference link in whatsnew --- docs/sphinx/source/whatsnew/v0.15.1.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/whatsnew/v0.15.1.rst b/docs/sphinx/source/whatsnew/v0.15.1.rst index 3f7a1a7efa..19a87fe1cd 100644 --- a/docs/sphinx/source/whatsnew/v0.15.1.rst +++ b/docs/sphinx/source/whatsnew/v0.15.1.rst @@ -53,7 +53,7 @@ Documentation * Fix a broken docstring reference to ``grounddiffuse`` in :py:func:`pvlib.irradiance.poa_components` (:issue:`2089`, :pull:`2708`) -* Add :ref:`core-guidelines` to the :ref:`_introduction-to-contributing` page. +* Add :ref:`core-guidelines` to the :ref:`introduction-to-contributing` page. (:issue:`2716`, :pull:`2726`)