Skip to content

Commit dce21b5

Browse files
RDaxiniechedey-lskandersolarcwhanse
authored
Add AI acknowledgement checkbox and welcome comment (pvlib#2624)
* Update PULL_REQUEST_TEMPLATE.md * shorten pr checkbox * add welcome for pr and issue * misc * Update v0.13.2.rst * remove issue +tag co-authors Co-Authored-By: Echedey Luis <80125792+echedey-ls@users.noreply.github.com> Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com> * transfer whatsnew entry * update message * Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Cliff Hansen <cwhanse@sandia.gov> * Update v0.15.1.rst * Update docs/sphinx/source/whatsnew/v0.15.1.rst Co-authored-by: Echedey Luis <80125792+echedey-ls@users.noreply.github.com> --------- Co-authored-by: Echedey Luis <80125792+echedey-ls@users.noreply.github.com> Co-authored-by: Kevin Anderson <57452607+kandersolar@users.noreply.github.com> Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
1 parent 2602596 commit dce21b5

3 files changed

Lines changed: 27 additions & 0 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
- [ ] Closes #xxxx
44
- [ ] I am familiar with the [contributing guidelines](https://pvlib-python.readthedocs.io/en/latest/contributing/index.html)
5+
- [ ] I attest that all AI-generated material has been vetted for accuracy and is in compliance with the pvlib license
56
- [ ] Tests added
67
- [ ] Updates entries in [`docs/sphinx/source/reference`](https://github.com/pvlib/pvlib-python/blob/main/docs/sphinx/source/reference) for API changes.
78
- [ ] Adds description and name entries in the appropriate "what's new" file in [`docs/sphinx/source/whatsnew`](https://github.com/pvlib/pvlib-python/tree/main/docs/sphinx/source/whatsnew) for all changes. Includes link to the GitHub Issue with `` :issue:`num` `` or this Pull Request with `` :pull:`num` ``. Includes contributor name and/or GitHub username (link with `` :ghuser:`user` ``).

.github/workflows/welcome.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Welcome First-Time Contributor
2+
3+
on:
4+
pull_request_target:
5+
types: opened
6+
7+
jobs:
8+
welcome:
9+
runs-on: ubuntu-latest
10+
permissions:
11+
pull-requests: write
12+
steps:
13+
- uses: plbstl/first-contribution@v4
14+
with:
15+
pr-opened-msg: |
16+
### Hey @{fc-author}! :tada:
17+
18+
Thanks for opening your first pull request! We appreciate your
19+
contribution. Please ensure you have reviewed and understood the
20+
[contributing guidelines](https://pvlib-python.readthedocs.io/en/latest/contributing/index.html).
21+
22+
If AI is used for any portion of this PR, you must vet the content
23+
for technical accuracy.

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ Documentation
3535
- :term:`aod500`
3636

3737
* Provide an overview of IAM modeling functionality in :ref:`iam`. (:pull:`2683`)
38+
* Add AI checkbox to PR template, and auto-generate a comment on PRs
39+
from first-time contributors regarding AI and contributing guidelines.
40+
(:issue:`2617`, :pull:`2624`)
3841

3942

4043
Testing

0 commit comments

Comments
 (0)