Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,31 @@ thought of being the motivation for your change.

Describe the modifications you've done.

## AI Usage
- [ ] Generated AI was used in this contribution

If checked, please provide an explanation on how AI was used in the development of this pull request:

- Description: _Include a high level description of Gen AI utilization_
- Type of assistance:
- [ ] Code generation
- [ ] Documentation
- [ ] Debugging
- [ ] Testing
- [ ] Refactoring
- [ ] Other:
- Scope of usage: _Which files, functions, or sections were AI-assisted_
- AI System used:
- [ ] ChatGPT
- [ ] Claude
- [ ] Gemini
- [ ] GitHub Copilot
- Level of modification:
- [ ] As-is
- [ ] Modified
- [ ] Used as inspiration
- Prompts used: _Please list or explain prompts that were used to develop this contribution_

## Result

What will change as a result of your pull request? Note that sometimes this
Expand Down
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,24 @@ We also welcome improvements to the project documentation or to the existing
docs. Please file an [issue](https://github.com/{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/issues).
-->

## AI Usage

AI tools *(LLMs, coding assistants)* are welcome as part of your contribution workflow, but they don't change who's responsible for the code you submit.

### Recommended uses

- Gaining understanding of the existing code, or solution ideas of the issue
- Translating or proofreading your comments or PR descriptions while keep the wording as close as possible to what you originally wrote

Whenever you use AI in any of these ways, disclose it explicitly in your PR description.

### Not recommended uses

- External AI tooling *(bots, agents)* directly interacting with the project, including creating issues, opening PRs, or commenting on GitHub
- Submitting AI generated code you can't explain line by line to a developer, or using AI output without fully understanding it or verifying it's the correct approach
- Submitting a PR where the effort you put in, such as writing a prompt, is less than the effort it would take a maintainer to review it. We can already write prompts or run automated tools ourselves and doing that directly is faster and more secure than reviewing a low effort PR.
- Using AI to increase the breadth of your contributions, such as spreading yourself across several projects at once. You provide more value by engaging deeply with one or two projects than shallowly with many.

## Policies

### Open Source Policy
Expand Down
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,7 @@ A list of core team members responsible for the code and documentation in this r
## Repository Structure

<!-- TODO: Including the repository structure helps viewers quickly understand the project layout. Using the "tree -d" command can be a helpful way to generate this information, but, be sure to update it as the project evolves and changes over time. -->

```plaintext
.
```

<!--TREE START--><!--TREE END-->

**{list directories and descriptions}**

Expand Down