medlogic
/
olivetin
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update AI.md

This commit is contained in:
James Read 2025-08-08 00:07:16 +01:00 committed by GitHub
parent c5b49b33ab
commit c526fa323e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
AI.md
View File

@ -7,8 +7,12 @@
## Development - Contributions
- [x] The project does accept contributions that were written with AI help, but the contribution must be attributed to a human username.
-- [x] The contribution should have come from a freely accessible open source model (coderabbitai pro which the project subscribes to is an exception).
- [x] The project **does accept** contributions that were written with AI help. **However**:
- The contribution must be attributed to a human username who takes responsibility for the code as if they wrote it themselves.
- AI often generates very unmaintainable code as it gets longer - loads of duplication, very little function re-use amd very poor at following style guides / idiomatic design. All code contributions (AI or not) are scrutinized hard for **maintainability** and **clean merging**. Please follow the CONTRIBUTORS guide.
- AI that helps with short tab completion is generally fine.
- AI that writes lots of new code across lots of files, or makes lots of superfluous changes is generally less likely to be accepted.
- Vibe coding is not a suitable way to contribute to this project.
- [x] Contributors should declare when AI has been used to help write contributions.
- [x] The project uses AI as an **optional** part of the PR process (coderabbitai). Please raise any concerns about usage within the PR.
-- [x] Suggestions from coderabbitai can be accepted verbaitem, but ideally it should be the PR author that uses coderabbitai as a guide, who then re-writes the contribution.