Skip to content

Commit f776b0d

Browse files
committed
[GH] Add AI statements to PR template and guide
1 parent 3d86636 commit f776b0d

File tree

2 files changed

+102
-0
lines changed

2 files changed

+102
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,31 @@ Closes #
1818

1919
<!-- A minimal, complete, and reproducible example demonstrating features introduced by this pull request. See https://stackoverflow.com/help/minimal-reproducible-example for additional suggestions on how to create such an example. -->
2020

21+
22+
**AI Statement (required)**
23+
24+
<!-- Please include one of the following options in your PR description:
25+
26+
- **No generative AI was used.** This contribution was written entirely without AI
27+
assistance.
28+
- **Limited use of generative AI.**
29+
Standard or boilerplate code snippets were generated with AI and manually reviewed;
30+
all design, logic, and implementation decisions were made by the contributor.
31+
Examples: IDE code-completions or brief LLM queries for common patterns.
32+
- **Extensive use of generative AI.**
33+
Significant portions of code or documentation were generated with AI, including
34+
logic and implementation decisions. All generated code and documentation were
35+
reviewed and understood by the contributor. Examples: Output from agentic coding
36+
tools and/or substantial refactoring by LLMs (web-based or local).
37+
38+
For additional information on Cantera's AI policy, see https://github.com/Cantera/cantera/blob/main/CONTRIBUTING.md-->
39+
40+
2141
**Checklist**
2242

2343
- [ ] The pull request includes a clear description of this code change
2444
- [ ] Commit messages have short titles and reference relevant issues
2545
- [ ] Build passes (`scons build` & `scons test`) and unit tests address code coverage
2646
- [ ] Style & formatting of contributed code follows [contributing guidelines](https://github.com/Cantera/cantera/blob/main/CONTRIBUTING.md)
47+
- [ ] AI Statement is included
2748
- [ ] The pull request is ready for review

CONTRIBUTING.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ provide a starting point for contributing code to Cantera.
4040
prepare your contribution in a way that makes it efficient to review.
4141

4242
## Getting Credit for your Contributions
43+
4344
* Configure Git with your name and e-mail address before making any commits
4445
* From a terminal, run:
4546
```shell
@@ -92,3 +93,83 @@ The following pages describe the Git development workflows for some other projec
9293
may also find some helpful advice from these projects:
9394
* [Matplotlib](https://matplotlib.org/devdocs/devel/development_workflow.html)
9495
* [SciPy](https://docs.scipy.org/doc/scipy/dev/contributor/development_workflow.html)
96+
97+
## Restrictions on Generative AI Usage
98+
99+
We expect authentic engagement in our community.
100+
101+
- Do not post output from Large Language Models or similar generative AI as comments on
102+
GitHub or our User Group, as such comments tend to be formulaic and low content.
103+
- If you use generative AI tools as an aid in developing code or documentation changes,
104+
you are required to disclose the use of AI and ensure that you fully understand the
105+
proposed changes and can explain why they are the correct approach.
106+
107+
Make sure you have added value based on your personal competency to your contributions.
108+
Just taking some input, feeding it to an AI and posting the result is not of value to
109+
the project. To preserve precious core developer capacity, we reserve the right to
110+
rigorously reject seemingly AI generated low-value contributions.
111+
(_adopted from
112+
[Matplotlib's AI Usage](https://matplotlib.org/devdocs/devel/contribute.html#restrictions-on-generative-ai-usage)
113+
guidelines_)
114+
115+
## AI Disclosures and Authorship
116+
117+
Cantera is distributed under a BSD-3-Clause license with contributions from
118+
California Institute of Technology, Sandia Corporation (with U.S. Government rights),
119+
and the Cantera Developers. Because this license requires clear attribution and
120+
provenance, contributors must follow the rules below when using generative AI tools.
121+
122+
### **1. AI Use Disclosure**
123+
124+
All pull requests must include a brief **AI Use Statement** in the PR description:
125+
126+
- **No generative AI was used.** This contribution was written entirely without AI
127+
assistance.
128+
- **Limited use of generative AI.**
129+
Standard or boilerplate code snippets were generated with AI and manually reviewed;
130+
all design, logic, and implementation decisions were made by the contributor.
131+
Examples: IDE code-completions or brief LLM queries for common patterns.
132+
- **Extensive use of generative AI.**
133+
Significant portions of code or documentation were generated with AI, including
134+
logic and implementation decisions. All generated code and documentation were
135+
reviewed and understood by the contributor. Examples: Output from agentic coding
136+
tools and/or substantial refactoring by LLMs (web-based or local).
137+
138+
**How to choose:**
139+
- **Limited:** AI helped with syntax, boilerplate, or standard patterns; you designed
140+
the solution.
141+
- **Extensive:** AI suggested the approach, algorithm, or structure; you validated it
142+
works.
143+
144+
### **2. Authorship and Licensing Requirements**
145+
146+
Contributors must ensure that:
147+
148+
- They have the rights to license their contribution under the project’s BSD-3-Clause
149+
terms.
150+
- They do **not knowingly** submit AI-generated content derived from copyrighted or
151+
license-incompatible sources (examples: GPL code, proprietary libraries).
152+
- All required attribution and copyright notices for contributed material are preserved
153+
as required under BSD-3-Clause.
154+
155+
### **3. Provenance Awareness**
156+
157+
As generative AI systems may emit material similar to third-party codebases,
158+
contributors must exercise caution. Contributors should exercise reasonable care in:
159+
160+
- verifying that AI suggestions are sufficiently original,
161+
- avoiding verbatim snippets from incompatible licenses, and
162+
- ensuring that any third-party content incorporated intentionally follows proper
163+
attribution and is license-compatible.
164+
165+
### **4. Maintainer Review and Discretion**
166+
167+
Maintainers may:
168+
169+
- request clarification about the origin of AI-assisted code,
170+
- ask the contributor to manually rewrite suspect portions, or
171+
- reject contributions where provenance is unclear or license compatibility cannot be
172+
reasonably established.
173+
174+
These measures protect the integrity of the project’s licensing and long-term
175+
maintainability.

0 commit comments

Comments
 (0)