docs(contributing): add commit standards, PR guidelines, and review timeline - #211
ANAMASGARD wants to merge 2 commits into
Conversation
…imeline Expand org-level CONTRIBUTING.md with repo-agnostic guidance for commit messages, PR checklists, review timelines, and testing principles while pointing contributors to per-repo setup docs. Signed-off-by: Gaurav Chaudhary <chaudharygaurav2004@gmail.com>
|
[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 |
|
Welcome @ANAMASGARD! It looks like this is your first PR to karmada-io/community 🎉 |
karmada-bot
added
the
size/M
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the CONTRIBUTING.md file to include a comprehensive PR checklist, detailed commit message standards (including DCO sign-off rules), a review timeline, testing guidelines, and a repository setup guide for the various repositories in the Karmada organization. The review feedback suggests clarifying the target repository for pull requests as the 'upstream repository', linking internally to the new commit message standards section, and refining the setup documentation entry for the community repository to avoid confusion.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| - Make commits of logical units. | ||
| - Push changes in a topic branch to a personal fork of the repository. | ||
| - Submit a pull request to [karmada-io/karmada](https://github.com/karmada-io/karmada). | ||
| - Submit a pull request to the repository you forked. |
There was a problem hiding this comment.
The phrase "the repository you forked" can be ambiguous, as it might be interpreted by some readers as referring to their own personal fork (the repository they created by forking). To make it completely clear that the PR should be submitted to the original project, consider using "the upstream repository".
| - Submit a pull request to the repository you forked. | |
| - Submit a pull request to the upstream repository. |
| @@ -104,3 +180,14 @@ To make it easier for your PR to receive reviews, consider the reviewers will ne | |||
| * follow [good coding guidelines](https://github.com/golang/go/wiki/CodeReviewComments). | |||
| * write [good commit messages](https://chris.beams.io/posts/git-commit/). | |||
There was a problem hiding this comment.
Since this PR introduces a dedicated and comprehensive Commit Message Standards section, we should link to that internal section instead of repeating the external link to the general Chris Beams post. This ensures contributors follow the project-specific standards (including conventional commits and DCO sign-off).
| * write [good commit messages](https://chris.beams.io/posts/git-commit/). | |
| * follow the [Commit Message Standards](#commit-message-standards). |
| |---|---| | ||
| | [karmada-io/karmada](https://github.com/karmada-io/karmada) | [CONTRIBUTING.md](https://github.com/karmada-io/karmada/blob/master/CONTRIBUTING.md) | | ||
| | [karmada-io/website](https://github.com/karmada-io/website) | [README.md](https://github.com/karmada-io/website/blob/main/README.md) | | ||
| | [karmada-io/community](https://github.com/karmada-io/community) | This file — docs/governance only, no build step required | |
There was a problem hiding this comment.
Referring to "This file" under the "Setup docs" column can be slightly confusing because this file (CONTRIBUTING.md) is a general contributing guide rather than setup documentation. Since the community repository only contains documentation and governance files and requires no environment setup, it would be clearer to state "None" or "No setup required".
| | [karmada-io/community](https://github.com/karmada-io/community) | This file — docs/governance only, no build step required | | |
| | [karmada-io/community](https://github.com/karmada-io/community) | None — docs/governance only, no build step required | |
Clarify upstream PR target, link Code Review to commit standards section, and mark community repo as having no setup docs. Signed-off-by: Gaurav Chaudhary <chaudharygaurav2004@gmail.com>
2 participants
Summary
CONTRIBUTING.mdwith commit message standards, PR checklist, review timeline, and testing principlesWhy
The current
CONTRIBUTING.mdis minimal and leaves new contributors without practical guidance. This addresses issue #199 while staying repo-agnostic per maintainer feedback on #200.Test plan
#pr-checklist,#commit-message-standards,#review-timeline,#testing,#repository-setup)[Contributing](#contributing)anchor left unchangedmake verify/make testor repo-specific tooling versions addedC02MUF8QXUNREVIEWERS.mdandAPPROVERS.mdlinks target existing filesFixes #199