mirror of
https://github.com/zama-ai/tfhe-rs.git
synced 2026-01-05 04:44:41 -05:00
chore: add artificial intelligence contribution guidelines
This commit is contained in:
committed by
IceTDrinker
parent
ac6178fd35
commit
4229523c50
@@ -110,9 +110,31 @@ Before creating a pull request, rebase your branch on the repository's `main` br
|
||||
|
||||
## 6. Opening a Pull Request
|
||||
|
||||
Once your changes are ready, open a pull request.
|
||||
Once your changes are ready, open a Pull Request. (Refer to GitHub's [official documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).)
|
||||
|
||||
For instructions on creating a PR from a fork, refer to GitHub's [official documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
|
||||
Before requesting a review, please ensure your work compiles and runs as intended. Note that reviewers are not responsible for guiding contributors through code debugging.
|
||||
|
||||
### Guidelines about AI usage
|
||||
|
||||
At Zama, we believe that human reasoning, critical thinking, and authentic communication during development could bring more value than LLMs.
|
||||
|
||||
We therefore expect contributors to follow these guidelines when using AI:
|
||||
|
||||
1. **Clearly disclose AI assistance** in your PR description. For example:
|
||||
> "I consulted ChatGPT to understand part of the codebase, but the implementation was written manually by me."
|
||||
|
||||
> "This PR includes code suggestions generated by Claude Code, which I reviewed, modified, and validated."
|
||||
|
||||
- Please note:
|
||||
- Pull Requests that include AI-generated code **without clear disclosure and human review** will not be accepted
|
||||
- You must be able to **explain and justify** every part of the submitted code.
|
||||
- The final contribution must reflect **your own reasoning, understanding, and design decisions**.
|
||||
|
||||
2. Avoid lengthy or wordy AI-generated texts:
|
||||
- Use AIs for inspirations but never let them speak for you 100%.
|
||||
- We recommend writing your own GitHub issues, comments, and PR descriptions. Perfect grammar is not required, authenticity is valued more than polish.
|
||||
|
||||
Respecting these guidelines shows respect for the community and ensures efficient and valuable contributions.
|
||||
|
||||
## 7. Continuous integration
|
||||
|
||||
|
||||
Reference in New Issue
Block a user