[GH] Address reviewer comments

This commit is contained in:
Ingmar Schoegl committed 2025-12-20 12:12:33 -06:00
1 parent 03e8370635
commit 9e5ad0a679
2 files changed
+13 -12

No files matched your search

+2 -1
View File
@@ -35,7 +35,8 @@ Closes #
reviewed and understood by the contributor. Examples: Output from agentic coding
tools and/or substantial refactoring by LLMs (web-based or local).
For additional information on Cantera's AI policy, see https://github.com/Cantera/cantera/blob/main/CONTRIBUTING.md -->
For additional information on Cantera's AI policy, see
https://github.com/Cantera/cantera/blob/main/CONTRIBUTING.md#restrictions-on-generative-ai-usage -->
**Checklist**
+11 -11
View File
@@ -98,21 +98,21 @@ may also find some helpful advice from these projects:
We expect authentic engagement in our community.
- Do not post output from Large Language Models or similar generative AI as comments on
GitHub or our User Group, as such comments tend to be formulaic and low content.
- Please be considerate posting content generated by AI models. Make sure that the
content is valuable, concise, and expresses the message you want to share.
- If you use generative AI tools as an aid in developing code or documentation changes,
you are required to disclose the use of AI and ensure that you fully understand the
proposed changes and can explain why they are the correct approach.
Make sure you have added value based on your personal competency to your contributions.
Just taking some input, feeding it to an AI and posting the result is not of value to
the project. To preserve precious core developer capacity, we reserve the right to
rigorously reject seemingly AI generated low-value contributions.
(_adopted from
the project. To preserve core developer capacity, we reserve the right to reject
low-value contributions.
(_adapted from
[Matplotlib's AI Usage](https://matplotlib.org/devdocs/devel/contribute.html#restrictions-on-generative-ai-usage)
guidelines_)
## AI Disclosures and Authorship
## Disclosures and Authorship
Cantera is distributed under a BSD-3-Clause license with contributions from
California Institute of Technology, Sandia Corporation (with U.S. Government rights),
@@ -121,7 +121,9 @@ provenance, contributors must follow the rules below when using generative AI to
### **1. AI Use Disclosure**
All pull requests must include a brief **AI Use Statement** in the PR description:
All pull requests must include a brief **AI Use Statement** in the PR description.
Please start with the appropriate category below, and in the latter cases, adjust
the description to describe how generative AI was used in this specific PR.
- **No generative AI was used.** This contribution was written entirely without AI
assistance.
@@ -152,17 +154,15 @@ Contributors must ensure that:
- All required attribution and copyright notices for contributed material are preserved
as required under BSD-3-Clause.
### **3. Provenance Awareness**
As generative AI systems may emit material similar to third-party codebases,
contributors must exercise caution. Contributors should exercise reasonable care in:
- verifying that AI suggestions are sufficiently original,
- avoiding verbatim snippets from incompatible licenses, and
- avoiding verbatim snippets with incompatible licenses, and
- ensuring that any third-party content incorporated intentionally follows proper
attribution and is license-compatible.
### **4. Maintainer Review and Discretion**
### **3. Maintainer Review and Discretion**
Maintainers may: