kubernetes-sigs / kubernetes-sigs/node-readiness-controller
[TRACKING] Improve Contributing Guidelines
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 164
- Forks
- 75
- Avg merge
- 8d 23h
- Merged PRs (30d)
- 13
Description
Currently, the NRC repository lacks custom guidelines for contributors, which leads to inconsistency on issues/PRs and manual toil on maintainers.
We may consider:
- Adding Issues templates/forms
- Implementing a standardized label schema (kind/ area/ priority/)
- Customizing CONTRIBUTING.md (including local setup & dev environment)
- Document available tests, add instructions for writing tests setting up ProwJobs
[edit: a few changes were deemed not necessary after discussion]
- [ ] Improving PR templates
- [ ] Standardizing commit messages (e.g., Conventional Commits)
- [ ] Adding policies for Branch naming
- [ ] Defining Merge/Squash policy for clean history
Adding guidelines/policies on how to contribute helps contributors have a clear path and facilitates automating chores like release notes, changelogs and triaging. It also makes it possible to provide contributors instant feedback through CI checks.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the existing CONTRIBUTING.md, issue templates/forms, test documentation, and ProwJob setup instructions to identify what is already covered. Define the contribution workflow and label or testing guidance that the repository lacks, then verify that the resulting documentation gives contributors a clear local setup, testing, and issue/PR path.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, kubernetes
- Domain
- ci-cd, developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100