Skip to content

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

Merged
Naramsim merged 6 commits intomasterfrom
phalt-patch-1
Apr 4, 2026
Merged

Update AI-assisted coding guidelines in CONTRIBUTING.md#1439
Naramsim merged 6 commits intomasterfrom
phalt-patch-1

Conversation

@phalt
Copy link
Copy Markdown
Member

@phalt phalt commented Mar 13, 2026

Change description

Because it's getting way too much, man.

We need to be clearer about what is an is acceptable.

We are not here to teach people good use of LLM tooling, but we are still dealing with potentially a lot of AI miss use.

OSS and Github has fundamentally changed and there is no clear way to deal with this.

AI coding assistance disclosure

For this change, I wrote everything by hand.

Contributor check list

  • I have written a description of the issue and explained why the fix solves the problem.
  • I have written tests for my code changes. (NOT APPLICABLE)
  • I have read and understood the AI Assisted Contribution guidelines.
  • I will own this change in production, and I am prepared to fix any bugs caused by my code change.

Because it's getting way too much, man.
@phalt phalt requested a review from Naramsim March 13, 2026 10:52
* Consider adding the `no-deploy` label if this PR shouldn't be deployed and does not alter the data served by the API.
-->

- [ ] I have read and understood the [AI Assisted Contribution guidelines](https://github.com/PokeAPI/pokeapi/blob/master/CONTRIBUTING.md#ai-assisted-coding) No newline at end of file
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I think we should add more things to this

@Naramsim
Copy link
Copy Markdown
Member

Before commenting I'll see what some popular old open source projects are doing as well.

@phalt
Copy link
Copy Markdown
Member Author

phalt commented Mar 13, 2026

This is Ghostty's policy: https://github.com/ghostty-org/ghostty/blob/main/AI_POLICY.md

Let's find some others and compare them.

@phalt
Copy link
Copy Markdown
Member Author

phalt commented Mar 20, 2026

@Naramsim I'll get back to this when I get a free moment.

For now though, major maintainers of Python and the Python ecosystem recently had this to say about AI contributions in OSS: https://pydantic.dev/articles/pyai-oss-panel Worth reading.

@phalt phalt requested review from Naramsim and jemarq04 March 24, 2026 08:58
@phalt
Copy link
Copy Markdown
Member Author

phalt commented Mar 24, 2026

Feedback implemented.


## Change description

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

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.

CONTRIBUTING.md Outdated
The types of AI-assisted coding that will be accepted:

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

Choose a reason for hiding this comment

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

test patterns/test generation

@phalt phalt requested a review from Naramsim April 1, 2026 10:00
Co-authored-by: Justin Marquez <37006684+jemarq04@users.noreply.github.com>
@Naramsim Naramsim added the no-deploy Instructs the updater-bot not to deploy this PR label Apr 4, 2026
@Naramsim Naramsim merged commit 4be43e0 into master Apr 4, 2026
7 of 9 checks passed
@pokeapi-machine-user
Copy link
Copy Markdown

This Pull Request won't be deployed since the label no-deploy was found in its meta-data.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-deploy Instructs the updater-bot not to deploy this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants