This is an automated email from the ASF dual-hosted git repository.
twice pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/kvrocks-website.git
The following commit(s) were added to refs/heads/main by this push:
new 187907d0 Add guidelines for AI-assisted contributions to contributing
page (#344)
187907d0 is described below
commit 187907d0ff6b0ab7974139b52f7225057145535d
Author: Twice <[email protected]>
AuthorDate: Tue Dec 16 20:33:29 2025 +0800
Add guidelines for AI-assisted contributions to contributing page (#344)
---
community/contributing.md | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/community/contributing.md b/community/contributing.md
index ee0084a7..87cfb931 100644
--- a/community/contributing.md
+++ b/community/contributing.md
@@ -46,6 +46,17 @@ You can use `./x.py test go <BUILD_DIR> -run <PATTERN>` to
run Golang test cases
After opening your pull request (PR), you can choose some reviewers, although
it is not mandatory. We suggest you to choose a reviewer recommended by GitHub
based on code snippets you modified, or some active community members (which
can be found in the [Community](index.md#people) page). After one or more
committers have approved your PR and the rest of the community has no
objections, congratulations, your PR will be merged into the unstable branch as
soon as possible.
+## Guidelines for AI-assisted Contributions
+
+AI tools are welcome as helpers, not authors. Keep these practices in mind:
+
+- Stay accountable: only submit changes you understand and can justify; be
ready to explain behavior, edge cases, and alignment with Kvrocks conventions.
If an AI suggestion feels unclear, rewrite or drop it.
+- Keep humans in the loop: discuss non-trivial ideas early via Issues,
Discussions, or Mailing Lists, especially when you are unsure about design or
impact.
+- Use AI for acceleration, then verify: treat AI output as a draft for code,
tests, or docs; run linters/tests and review the logic yourself.
+- Be transparent in PRs: note briefly if AI was used and for what (e.g.,
initial draft, test scaffolding), and call out any parts where you want extra
review.
+- Respect ASF policy: ensure generated content does not introduce incompatible
licenses or undisclosed third-party code; review the ASF Generative Tooling
Guidance and licensing rules when in doubt.
+- Prefer focused patches over large dumps; if you cannot confidently explain
an AI-produced change, open a well-described issue instead.
+
## Submit patches to document or project website
Contributions to the documentation and the project website are strongly
encouraged, as they are often much less frequent.
