Skip to content

Update AI-assisted coding guidelines in CONTRIBUTING.md #1439

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
phalt wants to merge 4 commits into
base: master
Choose a base branch
from
+35 −3
Open

Update AI-assisted coding guidelines in CONTRIBUTING.md #1439

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e7ad0d7
Update AI-assisted coding guidelines in CONTRIBUTING.md
phalt Mar 13, 2026
0650603
Update pull_request_template
phalt Mar 13, 2026
ee6e4d2
Merge branch 'master' into phalt-patch-1
Naramsim Mar 13, 2026
16997b4
Update review template, modify contributing
phalt Mar 24, 2026
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
17 changes: 17 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,20 @@
* Include a description of the proposed changes and how to test them.
* Consider adding the `no-deploy` label if this PR shouldn't be deployed and does not alter the data served by the API.
-->

## Change description

<!--> Add your change description here <!-->
Copy link
Member

@Naramsim Naramsim Mar 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this supposed to be an HTML comment? I think it's a good idea, but the opening tag should be <!-- and the closing one -->

If we do like this the line is shown in the editor but no present in the rendered issue.


## AI coding assistance disclosure

<!--> Provide details on how you used AI coding to assist you in this change <!-->

## Contributor check list

<!-- > Your PR will not be reviewed until you have completed all these steps: <!-->

- [ ] I have written a description of the issue and explained why the fix solves the problem.
- [ ] I have written tests for my code changes.
Comment on lines +19 to +20
Copy link
Contributor

@jemarq04 jemarq04 Mar 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This may be pedantic, but some PRs are for additions of new data (new pokemon, abilities, etc.) or new features and this is specific to fixes. Maybe something like

Suggested change
- [ ] I have written a description of the issue and explained why the fix solves the problem.
- [ ] I have written tests for my code changes.
- [ ] I have written a description of the contribution and explained its motivation.
- [ ] I have written tests for my code changes (if applicable).

- [ ] I have read and understood the [AI Assisted Contribution guidelines](https://github.com/PokeAPI/pokeapi/blob/master/CONTRIBUTING.md#ai-assisted-coding).
- [ ] I will own this change in production, and I am prepared to fix any bugs caused by my code change.
21 changes: 18 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,30 @@ Simple!

## AI assisted coding

Using AI assisted coding tools for auto complete, test generation, etc is allowed so long as a human is the overall primary author of a pull request.
The types of AI-assisted coding that will be accepted:

- Scaffolding for common framework patterns
- Scaffolding for test patternstest generation
Copy link
Member

@Naramsim Naramsim Mar 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

test patterns/test generation

- Mass file editing for tedious repetitive changes

The types of AI changes that will **NOT** be accepted:

- Fully automated code generation
- AI generated comments and responses in code review
- Lack of understanding of the change

Contributions from supervised AI assisted coding agents who build the majority (or all of) a change, such as [co pilot tasks](https://github.blog/changelog/2025-10-28-a-mission-control-to-assign-steer-and-track-copilot-coding-agent-tasks/), will be accepted only on the following basis:

1. A human can verifiably prove they have reviewed and checked that the contribution does what it says it does.
2. The human author provides evidence of the prompt given to the AI agent, and the logs of it producing the change. (For example - co pilot tasks produces a public log).
3. The human author explicitly calls out that an supervised AI agent created the change when they make a pull request.
2. If requested, the human author must provide evidence of the prompt given to the AI agent, and the logs of it producing the change. (For example - co pilot tasks produces a public log).
3. If requested, the human author explicitly calls out that an supervised AI agent created the change when they make a pull request.
4. The human author is prepared to own the change (just like any other change they make) and fix any issues that arise from it.

### Maintainers decision is final

If you cannot sufficiently demonstrate good use of AI tooling we will close your change.

We contribute to this project in our free time. Our time is valuable. Our time is not to be spent doing the thinking for you because you outsourced work to an LLM coding agent.

## Financial contributions

Expand Down
Loading