add ai guidance in contributiong.md#1587
add ai guidance in contributiong.md#1587LiZhenCheng9527 wants to merge 2 commits intokmesh-net:mainfrom
Conversation
Signed-off-by: LiZhenCheng9527 <lizhencheng6@huawei.com>
|
@LiZhenCheng9527: The label(s) DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Summary of ChangesHello @LiZhenCheng9527, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces comprehensive guidelines for the use of AI tools in the Kmesh project's Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. AI writes the code, But human mind must review, Wisdom guides the way. Footnotes
|
|
/cc @hzxuzhonghu |
There was a problem hiding this comment.
Code Review
This pull request adds a new 'AI Guidance' section to the CONTRIBUTING.md file, establishing clear rules for using AI-assisted tools in contributions. The PR also refactors the table of contents for better organization. The new guidelines are well-defined and help maintain the quality and integrity of contributions. The changes look good.
There was a problem hiding this comment.
Pull request overview
This PR updates the contributor documentation to add guidance on acceptable use of AI tools when preparing pull requests, aiming to set expectations for authorship responsibility and reviewer interaction.
Changes:
- Reformats the CONTRIBUTING.md table of contents indentation.
- Adds a new “AI Guidance” section describing expectations for AI-assisted contributions.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
CONTRIBUTING.md
Outdated
|
|
||
| ## AI Guidance | ||
|
|
||
| Using AI tools to help write your PR is acceptable, but as the author, you are responsible for understanding every change. Do not leave the first review of AI generated changes to the reviewers, verify the changes (code review, testing, etc.) before submitting your PR. Reviewers may ask questions about your AI-assisted code, and if you cannot explain why a change was made, the PR will be closed. When responding to review comments, please do so without relying on AI tools. Reviewers want to engage directly with you, not with generated responses. If you used AI tools in preparing your PR, please disclose this in the "Special notes for your reviewer" section. All contributions must follow the contributions policies and use commit messages that align with the policy. Large AI generated PRs and AI generated commit messages are discouraged. |
There was a problem hiding this comment.
The AI Guidance section is a single very long line/paragraph. For readability and cleaner diffs, please wrap the text similarly to other paragraphs in this file (e.g., the wrapped lines in the Community Expectations section).
| Using AI tools to help write your PR is acceptable, but as the author, you are responsible for understanding every change. Do not leave the first review of AI generated changes to the reviewers, verify the changes (code review, testing, etc.) before submitting your PR. Reviewers may ask questions about your AI-assisted code, and if you cannot explain why a change was made, the PR will be closed. When responding to review comments, please do so without relying on AI tools. Reviewers want to engage directly with you, not with generated responses. If you used AI tools in preparing your PR, please disclose this in the "Special notes for your reviewer" section. All contributions must follow the contributions policies and use commit messages that align with the policy. Large AI generated PRs and AI generated commit messages are discouraged. | |
| Using AI tools to help write your PR is acceptable, but as the author, you are | |
| responsible for understanding every change. Do not leave the first review of AI | |
| generated changes to the reviewers, verify the changes (code review, testing, | |
| etc.) before submitting your PR. Reviewers may ask questions about your | |
| AI-assisted code, and if you cannot explain why a change was made, the PR will | |
| be closed. When responding to review comments, please do so without relying on | |
| AI tools. Reviewers want to engage directly with you, not with generated | |
| responses. If you used AI tools in preparing your PR, please disclose this in | |
| the "Special notes for your reviewer" section. All contributions must follow | |
| the contributions policies and use commit messages that align with the policy. | |
| Large AI generated PRs and AI generated commit messages are discouraged. |
CONTRIBUTING.md
Outdated
|
|
||
| ## AI Guidance | ||
|
|
||
| Using AI tools to help write your PR is acceptable, but as the author, you are responsible for understanding every change. Do not leave the first review of AI generated changes to the reviewers, verify the changes (code review, testing, etc.) before submitting your PR. Reviewers may ask questions about your AI-assisted code, and if you cannot explain why a change was made, the PR will be closed. When responding to review comments, please do so without relying on AI tools. Reviewers want to engage directly with you, not with generated responses. If you used AI tools in preparing your PR, please disclose this in the "Special notes for your reviewer" section. All contributions must follow the contributions policies and use commit messages that align with the policy. Large AI generated PRs and AI generated commit messages are discouraged. |
There was a problem hiding this comment.
Several occurrences of "AI generated" should be hyphenated as "AI-generated" (e.g., "AI-generated changes", "AI-generated PRs", "AI-generated commit messages") to be grammatically correct and consistent.
| Using AI tools to help write your PR is acceptable, but as the author, you are responsible for understanding every change. Do not leave the first review of AI generated changes to the reviewers, verify the changes (code review, testing, etc.) before submitting your PR. Reviewers may ask questions about your AI-assisted code, and if you cannot explain why a change was made, the PR will be closed. When responding to review comments, please do so without relying on AI tools. Reviewers want to engage directly with you, not with generated responses. If you used AI tools in preparing your PR, please disclose this in the "Special notes for your reviewer" section. All contributions must follow the contributions policies and use commit messages that align with the policy. Large AI generated PRs and AI generated commit messages are discouraged. | |
| Using AI tools to help write your PR is acceptable, but as the author, you are responsible for understanding every change. Do not leave the first review of AI-generated changes to the reviewers, verify the changes (code review, testing, etc.) before submitting your PR. Reviewers may ask questions about your AI-assisted code, and if you cannot explain why a change was made, the PR will be closed. When responding to review comments, please do so without relying on AI tools. Reviewers want to engage directly with you, not with generated responses. If you used AI tools in preparing your PR, please disclose this in the "Special notes for your reviewer" section. All contributions must follow the contributions policies and use commit messages that align with the policy. Large AI-generated PRs and AI-generated commit messages are discouraged. |
CONTRIBUTING.md
Outdated
|
|
||
| ## AI Guidance | ||
|
|
||
| Using AI tools to help write your PR is acceptable, but as the author, you are responsible for understanding every change. Do not leave the first review of AI generated changes to the reviewers, verify the changes (code review, testing, etc.) before submitting your PR. Reviewers may ask questions about your AI-assisted code, and if you cannot explain why a change was made, the PR will be closed. When responding to review comments, please do so without relying on AI tools. Reviewers want to engage directly with you, not with generated responses. If you used AI tools in preparing your PR, please disclose this in the "Special notes for your reviewer" section. All contributions must follow the contributions policies and use commit messages that align with the policy. Large AI generated PRs and AI generated commit messages are discouraged. |
There was a problem hiding this comment.
The sentence "All contributions must follow the contributions policies and use commit messages that align with the policy" is unclear: (1) "contributions policies" reads like a typo/incorrect phrase, and (2) "the policy" doesn’t indicate which policy is meant. Consider rephrasing and/or linking to the specific policy/guideline you intend (for commit messages, there is already a "good commit messages" link later in this document).
| Using AI tools to help write your PR is acceptable, but as the author, you are responsible for understanding every change. Do not leave the first review of AI generated changes to the reviewers, verify the changes (code review, testing, etc.) before submitting your PR. Reviewers may ask questions about your AI-assisted code, and if you cannot explain why a change was made, the PR will be closed. When responding to review comments, please do so without relying on AI tools. Reviewers want to engage directly with you, not with generated responses. If you used AI tools in preparing your PR, please disclose this in the "Special notes for your reviewer" section. All contributions must follow the contributions policies and use commit messages that align with the policy. Large AI generated PRs and AI generated commit messages are discouraged. | |
| Using AI tools to help write your PR is acceptable, but as the author, you are responsible for understanding every change. Do not leave the first review of AI generated changes to the reviewers, verify the changes (code review, testing, etc.) before submitting your PR. Reviewers may ask questions about your AI-assisted code, and if you cannot explain why a change was made, the PR will be closed. When responding to review comments, please do so without relying on AI tools. Reviewers want to engage directly with you, not with generated responses. If you used AI tools in preparing your PR, please disclose this in the "Special notes for your reviewer" section. All contributions must follow this project's contribution policies, and commit messages must follow the documented commit message guidelines. Large AI generated PRs and AI generated commit messages are discouraged. |
What type of PR is this?
/kind documentation
What this PR does / why we need it:
Enable the Kmesh community to use AI-generated code in a more standardized manner.
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Does this PR introduce a user-facing change?: