-
Notifications
You must be signed in to change notification settings - Fork 158
add ai guidance in contributiong.md #1587
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
LiZhenCheng9527
wants to merge
2
commits into
kmesh-net:main
Choose a base branch
from
LiZhenCheng9527:update-coc
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -3,19 +3,20 @@ | |||||||||
| Welcome to Kmesh! | ||||||||||
|
|
||||||||||
| - [Contributing](#contributing) | ||||||||||
| - [Before you get started](#before-you-get-started) | ||||||||||
| - [Code of Conduct](#code-of-conduct) | ||||||||||
| - [Community Expectations](#community-expectations) | ||||||||||
| - [Getting started](#getting-started) | ||||||||||
| - [Your First Contribution](#your-first-contribution) | ||||||||||
| - [Find something to work on](#find-something-to-work-on) | ||||||||||
| - [Find a good first topic](#find-a-good-first-topic) | ||||||||||
| - [Before you get started](#before-you-get-started) | ||||||||||
| - [Code of Conduct](#code-of-conduct) | ||||||||||
| - [Community Expectations](#community-expectations) | ||||||||||
| - [Getting started](#getting-started) | ||||||||||
| - [Your First Contribution](#your-first-contribution) | ||||||||||
| - [Find something to work on](#find-something-to-work-on) | ||||||||||
| - [Find a good first topic](#find-a-good-first-topic) | ||||||||||
| - [Work on an issue](#work-on-an-issue) | ||||||||||
| - [File an Issue](#file-an-issue) | ||||||||||
| - [Contributor Workflow](#contributor-workflow) | ||||||||||
| - [Creating Pull Requests](#creating-pull-requests) | ||||||||||
| - [Code Review](#code-review) | ||||||||||
| - [Membership](#membership) | ||||||||||
| - [File an Issue](#file-an-issue) | ||||||||||
| - [AI Guidance](#ai-guidance) | ||||||||||
| - [Contributor Workflow](#contributor-workflow) | ||||||||||
| - [Creating Pull Requests](#creating-pull-requests) | ||||||||||
| - [Code Review](#code-review) | ||||||||||
| - [Membership](#membership) | ||||||||||
|
|
||||||||||
| ## Before you get started | ||||||||||
|
|
||||||||||
|
|
@@ -75,6 +76,10 @@ Issues should be filed under the appropriate Kmesh sub-repository. | |||||||||
|
|
||||||||||
| Please follow the prompted submission guidelines while opening an issue. | ||||||||||
|
|
||||||||||
| ## 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. | ||||||||||
|
||||||||||
| 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. |
Outdated
Copilot
AI
Feb 10, 2026
There was a problem hiding this comment.
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. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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).