Skip to content

Commit bdde000

Browse files
committed
Changes to AI policy based on discussion
1 parent 3527285 commit bdde000

File tree

2 files changed

+25
-16
lines changed

2 files changed

+25
-16
lines changed

appendices/gen-ai-checklist.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
```markdown
2-
- [ ] Some parts of the package were created using LLMs in some way.
3-
* Please check any of the boxes below to clarify which parts of the package were impacted by LLM use
4-
- [ ] LLMs were used to develop code
5-
- [ ] LLMs were used to develop documentation
6-
- [ ] LLMs were used to develop tests
7-
- [ ] LLMs were used to develop infrastructure (CI, automation)
8-
9-
- [ ] I acknowledge that a human (at least one member of our maintainer team) has reviewed or edited all LLM-generated code and text submitted in this review to ensure it conveys intended meaning (if text) and the code runs (if code).
2+
- [ ] Generative AI was used to produce some of the material in this submission.
3+
- [ ] If generative AI was used in this project, the authors affirm that all generated material has been reviewed and edited for clarity, correctness, and completeness. The authors are responsible for the content of their work and affirm that it is in a state where reviewers will not be responsible for primary editing and review of machine-generated material.
4+
5+
If you checked the first box above, please describe how generative AI was used, including:
6+
7+
- **Which parts** of the submission were generated (e.g., documentation, tests, code). In addition to a general description, please specifically indicate any substantial portions of code (classes, modules, subpackages) that were wholly or primarily generated by AI.
8+
- **The approximate scale** of the generated portions (e.g., "all of the tests were generated and then checked by a human," "small routines were generated and copied into the code").
9+
- **How the generative AI was used** (e.g., line completion, help with translation, queried separately and integrated, agentic workflow).
10+
11+
If you have a policy around generative AI use in your project, please provide a link to it below:
12+
13+
- _Your link here (remove this line if you don't have a link)_
1014
```

our-process/policies.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -97,30 +97,34 @@ In the case where none of the associate editors can serve as editor, an
9797
external guest editor will be recruited to lead the package review.
9898

9999
(generative-ai-policy)=
100+
100101
## Policy for use of generative AI / LLMs
101102

102103
:::{admonition} How this policy was developed
103104
:class: important
104105

105106
The policy below was co-developed by the pyOpenSci community. Its goals are:
106107

107-
* Acknowledgment of and transparency around the widespread use of Generative AI tools, with a focus on Large Language Models (LLMs) in Open Source development.
108-
* Protect peer review efficiency: Ensure human review of any LLM-generated contributions to a package to protect editor and reviewer volunteer time in our peer review process.
109-
* Raise awareness of challenges that Generative AI tools present to the scientific (and broader) open source community.
108+
- Acknowledgment of and transparency around the widespread use of Generative AI tools, with a focus on Large Language Models (LLMs) in Open Source development.
109+
- Ensure an equitable balance of effort in the peer review process: Authors acknowledge that a human has carefully reviewed parts of the package that are AI-generated. Generated material should be in a state that minimizes review time. Our reviewers are not responsible for correcting errors in machine-generated content.
110+
- Disclosure allows reviewers and editors to make informed decisions around the types of packages that they wish to review code for.
111+
- Raise awareness of challenges that Generative AI tools present to the scientific (and broader) open source community.
112+
110113
[Please see this GitHub issue for a discussion of the topic.](https://github.com/pyOpenSci/software-peer-review/issues/331)
111114
:::
112115

113116
### Disclosure of generative AI use in pyOpenSci reviewed packages
114117

115-
* When you submit a package to pyOpenSci, please disclose any use of LLMs (Large Language Models) in your packages development by checking the appropriate boxes on our software submission form. Disclosure should generally include what parts of your package were developed using LLM tools.
116-
* Please also disclose this use of Generative AI tools in your package's `README.md` file and in any modules where generative AI contributions have been implemented.
117-
* We require that all aspects of your package have been reviewed carefully by a human on your maintainer team. Please ensure all text and code have been carefully checked for bias, bugs, and issues before submitting to pyOpenSci.
118-
* Your acknowledgment of using Generative AI will not impact the success of your submission unless you have blindly copied text and code into your package without careful review and evaluation of its accuracy, and for any systemic bias.
119-
* If the review team (comprised of the editor and reviewers) determines that the code and text in the package are too challenging to review, they can decide to pause and/or discontinue the review following this policy’s guidelines.
118+
- When you submit a package to pyOpenSci, please disclose any use of LLMs (Large Language Models) in your package's development by checking the appropriate box and describing your use of generative AI in its development and/or maintenance on our software submission form. Disclosure should include what parts of your package were developed using Generative AI tools.
119+
- Please also disclose this use of Generative AI tools in your package's `README.md` file and in any modules where generative AI contributions have been implemented.
120+
- We require that all aspects of your package have been reviewed carefully by a human on your maintainer team. Please ensure all text and code have been carefully checked for bugs and issues before submitting to pyOpenSci.
121+
- Your acknowledgment of using Generative AI will not prejudice the success of your submission. However, a reviewer can and will ask you to revisit your package's content if it appears that sections have been copied and pasted from other sources without human review.
122+
- If the review team (comprised of the editor and reviewers) determines that the code and text in the package are too challenging to review, they can decide to pause and/or discontinue the review following this policy’s guidelines.
120123

121124
Below is the checklist that you will need to respond to in our submission form:
122125

123126
```{include} ../appendices/gen-ai-checklist.md
127+
124128
```
125129

126130
## Review timelines and on-hold reviews
@@ -209,6 +213,7 @@ recently released version of that package in our ecosystem for archival
209213
purposes only.
210214

211215
(package-archive)=
216+
212217
### Archiving a package
213218

214219
If a package appears to be no longer maintained, we will mark it as

0 commit comments

Comments
 (0)