feat: add genai policy to templates #288
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -29,6 +29,17 @@ Date accepted (month/day/year): TBD | |||||
| - [ ] I agree to abide by [pyOpenSci's Code of Conduct][PyOpenSciCodeOfConduct] during the review process and in maintaining my package after should it be accepted. | ||||||
| - [ ] I have read and will commit to package maintenance after the review as per the [pyOpenSci Policies Guidelines][Commitment]. | ||||||
|
|
||||||
| ## Development Best Practices & GenerativeAI Use Disclosure | ||||||
|
|
||||||
|
lwasser marked this conversation as resolved.
|
||||||
| - [ ] This package has a public development history spanning 3-6 months, with commits distributed over time that reflect **iterative, thoughtful development.** | ||||||
| - [ ] All code in this package has been **carefully reviewed by a human**. Its implementation is also understood by the authors submitting the package. | ||||||
| - [ ] All communication on this issue will be written by a human (someone on your maintainer team). We embrace the use of LLMs for translation and grammar correction. We prefer honest interactions over ones that prioritize perfect language and grammar. As little aid from a LLM as possible. | ||||||
|
Member
Author
There was a problem hiding this comment.
Suggested change
|
||||||
| - [ ] **Generative AI tools were used to develop and maintain this package.** | ||||||
|
|
||||||
| ### Please list the tools and frameworks that you used below (Examples include Claude Code, Cursor, OpenClaw, ChatGPT, VSCode + Copilot) | ||||||
|
|
||||||
| ### Describe the nature and scope of support that LLMs provided. Examples include code generation, autocomplete, documentation development, refactoring, test development | ||||||
|
|
||||||
| ## Description | ||||||
|
lwasser marked this conversation as resolved.
|
||||||
|
|
||||||
| - Include a brief paragraph describing what your package does: | ||||||
|
|
@@ -117,8 +128,6 @@ Confirm each of the following by checking the box. | |||||
| submission and improve our peer review process. We will also ask our reviewers | ||||||
| and editors to fill this out. | ||||||
|
|
||||||
| ## Editor and Review Templates | ||||||
|
|
||||||
| The [editor template can be found here][Editor Template]. | ||||||
|
|
@@ -143,8 +152,6 @@ The [review template can be found here][Review Template]. | |||||
|
|
||||||
| [Review Template]: https://www.pyopensci.org/software-peer-review/appendices/templates.html#peer-review-template | ||||||
|
|
||||||
| [PangeoCollaboration]: https://www.pyopensci.org/software-peer-review/partners/pangeo | ||||||
|
|
||||||
| [pangeoWebsite]: https://www.pangeo.io | ||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,10 +18,10 @@ Over time we also hope to address the issue of multiple packages that have overl | |
| ## How to submit a package for review | ||
|
|
||
| To submit your package for peer review, you can open a GitHub issue: | ||
|
|
||
| 1. [Click here to start a presubmission inquiry - if you are unsure of whether your package is in scope for us you may want to click here to open an issue.](https://github.com/pyOpenSci/software-review/issues/new?assignees=&labels=0%2Fpresubmission&template=presubmission-inquiry.md&title=) | ||
| 2. [Click here to submit your package for peer review.](https://github.com/pyOpenSci/software-review/issues/new?assignees=&labels=1%2Feditor-checks%2C+New+Submission%21&template=submit-software-for-review.md&title=) | ||
|
|
||
| ## Why submit a package to pyOpenSci? | ||
| There are [numerous benefits to submitting your package to us for review](https://www.pyopensci.org/peer-review-guide/about-peer-review/review-benefits.html?highlight=benefits)including: | ||
|
|
||
|
|
@@ -49,10 +49,6 @@ Peer review is a valuable way to boost your data science skills. If you are inte | |
| * 📖 [What are the benefits of peer review?](https://www.pyopensci.org/peer-review-guide/about-peer-review/review-benefits.html) | ||
| * 📖 [Why is software peer review important](https://www.pyopensci.org/peer-review-guide/about-peer-review/intro.html#why-does-the-scientific-community-need-software-peer-review) | ||
|
|
||
| ## 👥 Our community 👥 | ||
| Our community is growing. | ||
|
|
||
|
|
@@ -63,7 +59,7 @@ Our community is growing. | |
|
|
||
| ## Contributors ✨ | ||
|
|
||
| Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key/)): | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> | ||
| <!-- prettier-ignore-start --> | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we shorten this? OR we can link to more about this. perhaps remove the translation piece
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd keep this as-is. There was a decent chunk of folks who didn't look at links present, this forces acknowledgement.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@coatless Does Leah's version below look ok to you? Still includes the bit about communication written by human, but links to our peer-review guide for the translation details.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure; but, I'll revoice that the more links present across multiple guides the less likely the submitters are going to go to them. Again, these are built-in to the template meaning that unless they copy & paste the URL to visit or switch to preview mode and click it's highly unlikely that these documents will be reviewed.