Skip to content

armgit / kaneo

Public Imported from GitHub
0

⚡ Project management that doesn't become the project. Boards, Gantt charts, and GitHub integration. Self-host it or use Kaneo Cloud.

docs: add AI contribution guidelines (#1593)

Tin Sever1786d5de3fdc
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index dd5d4eecf..9a15c6b90 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -28,6 +28,7 @@ Fixes #
<!-- Mark the appropriate options with an "x" -->
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
+- [ ] I understand and take responsibility for every change, and I wrote this pull request description in my own words
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
@@ -36,4 +37,4 @@ Fixes #
- [ ] Any dependent changes have been merged and published
## Additional Notes
-<!-- Add any other context about the PR here -->
\ No newline at end of file
+<!-- Add any other context about the PR here -->
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 6313e1e13..320bb958a 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -16,6 +16,7 @@ Thanks for wanting to contribute to Kaneo! Whether you're fixing bugs, adding fe
- [Commit Messages](#commit-messages)
- [Localization (i18n)](#localization-i18n)
- [Project Structure](#project-structure)
+- [Using AI](#using-ai)
- [Need Help?](#need-help)
## Code of Conduct
@@ -198,6 +199,26 @@ kaneo/
└── charts/ # Kubernetes Helm chart
```
+## Using AI
+
+You are welcome to use AI tools to help you contribute – we as maintainers do the same too. They are useful for research, writing code or tests, and exploring unfamiliar parts of the project. Two boundaries apply to every contribution.
+
+### Speak for yourself
+
+Write issues, pull request descriptions, and review replies in your own words. Clear, imperfect writing is better than a generated explanation that is longer than necessary or does not accurately describe the contribution.
+
+### Think for yourself
+
+Understand and take responsibility for every change you submit. Before requesting review, reproduce the problem, reduce the solution to its necessary scope, and verify the behavior yourself. You should be able to explain the design decisions, tradeoffs, and tests without relying on an AI-generated answer.
+
+AI output is not evidence that a change is correct. Include meaningful regression coverage for behavior changes and keep unrelated or speculative work out of the pull request.
+
+Automated review can be part of preparing an open pull request. Address relevant bot feedback and stabilize the change before requesting review from a maintainer.
+
+Maintainers may close a pull request without a detailed implementation review when its description is inaccurate, its scope exceeds the linked issue, important behavior is untested, or the author cannot explain and validate the submitted work. Review feedback identifies problems; it does not replace the contributor's own investigation and validation.
+
+For more context, see [this blog article](https://roe.dev/blog/using-ai-in-open-source).
+
## Need Help?
- **Discord**: Join our [Discord server](https://discord.gg/rU4tSyhXXU) for real-time help