Skip to content

Update CONTRIBUTING.md w/ AI guidance #21

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

Merged
alexmeckes merged 1 commit into from
Aug 7, 2025
Merged

Update CONTRIBUTING.md w/ AI guidance #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,9 @@ We welcome all kinds of contributions, from improving customization, to extendin

**Documentation**
- Update docs for changes to functionality and maintain consistency with existing docs.

**AI-Generated Code**

- We welcome AI-assisted contributions when used thoughtfully
- Be aware that AI sometimes generates incorrect code, hallucinates APIs, or uses deprecated methods
- Take extra care to verify the code works correctly and handles edge cases
Comment on lines +48 to +52

@Kostis-S-Z Kostis-S-Z Aug 1, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good. I would also add:

Suggested change
**AI-Generated Code**
- We welcome AI-assisted contributions when used thoughtfully
- Be aware that AI sometimes generates incorrect code, hallucinates APIs, or uses deprecated methods
- Take extra care to verify the code works correctly and handles edge cases
**AI-Generated Code**
- We welcome AI-assisted contributions when used thoughtfully
- Clearly disclose if any part of your submission was generated or assisted by AI tools.
- Be aware that AI sometimes generates incorrect code, hallucinates APIs, or uses deprecated methods
- Demonstrate thorough understanding of the code you submit.
- Carefully review, test, and debug all code before submitting. Do not blindly copy-paste output from AI tools.