Skip to content

Commit b329096

Browse files
committed
meta: add AI disclosure markings/contribution guidelines (#273)
1 parent 3983500 commit b329096

2 files changed

Lines changed: 23 additions & 0 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,24 @@ If you are not confident in forking the repository, making the change and sendin
4747

4848
Before the PR gets approved and merged, we may require a number of reviews from our contributors.
4949

50+
### AI disclosure
51+
52+
There are two different things to disclose: AI used to prepare your contribution, and AI used to make the resource you're adding.
53+
54+
**Your contribution.** If AI tools helped you prepare your PR (e.g. finding the resource or writing its description), follow the [gbdev AI policy](https://gbdev.io/aipolicy.html) and add an `Assisted-by` tag to your commit message.
55+
56+
**The resource.** Resources made with the help of AI are accepted, but they must be marked so readers can make up their own mind about them ([#273](https://github.com/gbdev/awesome-gbdev/issues/273)). Put the mark right after the link, before the description:
57+
58+
- `†` - AI-assisted: the resource contains some AI-generated content (code, documentation, assets), even a small part such as a helper script or a few fixes.
59+
- `‡` - AI-generated: most of the resource was made by AI (e.g. "vibe-coded" projects).
60+
61+
```
62+
- [resource](link) † - Description.
63+
- [resource](link) ‡ - Description.
64+
```
65+
66+
Also mention the AI usage in your PR description, along with how you know about it (e.g. the author says so, the repository has an `AGENTS.md` or `CLAUDE.md`, an AI agent appears among the commit authors). If you're unsure which mark applies, say so in the PR and the maintainers will decide.
67+
5068
### Checking your changes locally
5169

5270
CI runs two checks, here's how you can try them locally.

‎README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,12 +84,17 @@ You can find a (way cooler) web version of this list [here](https://gbdev.github
8484
>If you aim to develop your software for SGB or GBC, or you want to know how it runs on the other systems, you may want to take advantage and adapt to these differences, check the [Game Boy Color](#game-boy-color) category and look for specific references to GBC/CGB and SGB.
8585
8686

87+
88+
8789
## Community
8890

8991
- [Chat channels](https://gbdev.io/chat)
9092
- [Forum](https://gbdev.gg8.se/forums/)
9193

9294
<!-- gbdev.io:begin body -->
95+
96+
> Resources marked with † are developed with AI/LLM usage, resources marked with ‡ were mostly generated by AI. See [AI disclosure](CONTRIBUTING.md#ai-disclosure).
97+
9398
## Documentation
9499

95100
- [**Pan Docs**](https://gbdev.github.io/pandocs/) - The single, most comprehensive technical reference to Game Boy available to the public. Corrected, updated and maintained by the community.

0 commit comments

Comments
 (0)