Skip to content

add ai guidance in contributiong.md#1587

Open
LiZhenCheng9527 wants to merge 2 commits intokmesh-net:mainfrom
LiZhenCheng9527:update-coc
Open

add ai guidance in contributiong.md#1587
LiZhenCheng9527 wants to merge 2 commits intokmesh-net:mainfrom
LiZhenCheng9527:update-coc

Conversation

@LiZhenCheng9527
Copy link
Contributor

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?:


Signed-off-by: LiZhenCheng9527 <lizhencheng6@huawei.com>
Copilot AI review requested due to automatic review settings February 10, 2026 07:11
@kmesh-bot
Copy link
Collaborator

@LiZhenCheng9527: The label(s) kind/documentation cannot be applied, because the repository doesn't have them.

Details

In response to this:

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?:


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.

@kmesh-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from lizhencheng9527. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@gemini-code-assist
Copy link

Summary of Changes

Hello @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 CONTRIBUTING.md file. The primary goal is to establish a standardized approach for contributors leveraging AI-generated code, emphasizing the author's responsibility for understanding and verifying all changes, maintaining direct communication with reviewers, and ensuring adherence to project policies.

Highlights

  • AI Guidance Section Added: A new section titled "AI Guidance" was added to CONTRIBUTING.md to provide clear expectations for contributors using AI tools.
  • Table of Contents Updated: The table of contents in CONTRIBUTING.md was updated to include a link to the newly added "AI Guidance" section.

🧠 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
  • CONTRIBUTING.md
    • Added a new top-level section "AI Guidance" to outline policies for using AI tools in contributions.
    • Updated the document's table of contents to include the new "AI Guidance" section.
    • Detailed contributor responsibilities when using AI, such as verifying code, engaging directly with reviewers, disclosing AI tool usage, and discouraging large AI-generated PRs.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@LiZhenCheng9527 LiZhenCheng9527 added documentation Improvements or additions to documentation and removed size/S labels Feb 10, 2026
@LiZhenCheng9527
Copy link
Contributor Author

/cc @hzxuzhonghu

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

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.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.
Copy link

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

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

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).

Suggested change
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.

Copilot uses AI. Check for mistakes.
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.
Copy link

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
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.

Copilot uses AI. Check for mistakes.
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.
Copy link

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

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

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).

Suggested change
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.

Copilot uses AI. Check for mistakes.
Signed-off-by: LiZhenCheng9527 <lizhencheng6@huawei.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/S

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants