docs: add AI assistance notice (#1917)
* docs: add AI assistance notice * docs: add TODO item for AI disclosure
This commit is contained in:
1
.github/PULL_REQUEST_TEMPLATE.md
vendored
1
.github/PULL_REQUEST_TEMPLATE.md
vendored
@@ -4,6 +4,7 @@
|
|||||||
|
|
||||||
#### To-Dos
|
#### To-Dos
|
||||||
|
|
||||||
|
- [ ] Disclosed any use of AI (see our [policy](https://github.com/fallenbagel/jellyseerr/blob/docs-contributing/CONTRIBUTING.md#ai-assistance-notice))
|
||||||
- [ ] Successful build `pnpm build`
|
- [ ] Successful build `pnpm build`
|
||||||
- [ ] Translation keys `pnpm i18n:extract`
|
- [ ] Translation keys `pnpm i18n:extract`
|
||||||
- [ ] Database migration (if required)
|
- [ ] Database migration (if required)
|
||||||
|
|||||||
@@ -2,6 +2,45 @@
|
|||||||
|
|
||||||
All help is welcome and greatly appreciated! If you would like to contribute to the project, the following instructions should get you started...
|
All help is welcome and greatly appreciated! If you would like to contribute to the project, the following instructions should get you started...
|
||||||
|
|
||||||
|
## AI Assistance Notice
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
>
|
||||||
|
> If you are using **any kind of AI assistance** to contribute to Jellyseerr,
|
||||||
|
> it must be disclosed in the pull request.
|
||||||
|
|
||||||
|
If you are using any kind of AI assistance while contributing to Jellyseerr,
|
||||||
|
**this must be disclosed in the pull request**, along with the extent to
|
||||||
|
which AI assistance was used (e.g. docs only vs. code generation).
|
||||||
|
If PR responses are being generated by an AI, disclose that as well.
|
||||||
|
As a small exception, trivial tab-completion doesn't need to be disclosed,
|
||||||
|
so long as it is limited to single keywords or short phrases.
|
||||||
|
|
||||||
|
An example disclosure:
|
||||||
|
|
||||||
|
> This PR was written primarily by Claude Code.
|
||||||
|
|
||||||
|
Or a more detailed disclosure:
|
||||||
|
|
||||||
|
> I consulted ChatGPT to understand the codebase but the solution
|
||||||
|
> was fully authored manually by myself.
|
||||||
|
|
||||||
|
Failure to disclose this is first and foremost rude to the human operators
|
||||||
|
on the other end of the pull request, but it also makes it difficult to
|
||||||
|
determine how much scrutiny to apply to the contribution.
|
||||||
|
|
||||||
|
In a perfect world, AI assistance would produce equal or higher quality
|
||||||
|
work than any human. That isn't the world we live in today, and in most cases
|
||||||
|
it's generating slop. I say this despite being a fan of and using them
|
||||||
|
successfully myself (with heavy supervision)!
|
||||||
|
|
||||||
|
When using AI assistance, we expect contributors to understand the code
|
||||||
|
that is produced and be able to answer critical questions about it. It
|
||||||
|
isn't a maintainers job to review a PR so broken that it requires
|
||||||
|
significant rework to be acceptable.
|
||||||
|
|
||||||
|
Please be respectful to maintainers and disclose AI assistance.
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
### Tools Required
|
### Tools Required
|
||||||
@@ -158,4 +197,4 @@ DB_TYPE="postgres" DB_USER=postgres DB_PASS=postgres pnpm migration:generate ser
|
|||||||
|
|
||||||
## Attribution
|
## Attribution
|
||||||
|
|
||||||
This contribution guide was inspired by the [Next.js](https://github.com/vercel/next.js), [Radarr](https://github.com/Radarr/Radarr), and [Overseerr](https://github.com/sct/Overseerr) contribution guides.
|
This contribution guide was inspired by the [Next.js](https://github.com/vercel/next.js), [Radarr](https://github.com/Radarr/Radarr), [Overseerr](https://github.com/sct/Overseerr) and [Ghostty](https://github.com/ghostty-org/ghostty) contribution guides.
|
||||||
|
|||||||
Reference in New Issue
Block a user