Description
CONTRIBUTING.md has a few documentation gaps that could make onboarding harder for new contributors:
1. Stale branch name
The default branch is main, but line 62 says:
"This is usually master"
2. Missing local development setup
There are no instructions for:
- Required Go version
- Required tooling (Docker, Kustomize, etc.)
- How to run the project locally (build, configuration)
- How to set up a local Kubernetes cluster for testing
3. Sparse testing section
The testing section says "Run and pass make lint" and "Run and pass make test" but does not explain:
- How to run individual tests
- How to run end-to-end tests
- How to check coverage
4. No PR checklist
Many projects include a checklist for:
- Code style /
gofmt
- Documentation updates for changed APIs
- Changelog or release notes entry
I can submit a PR addressing these items if this would be helpful.
Related: #1166 (improve documentation quality)
Description
CONTRIBUTING.md has a few documentation gaps that could make onboarding harder for new contributors:
1. Stale branch name
The default branch is
main, but line 62 says:2. Missing local development setup
There are no instructions for:
3. Sparse testing section
The testing section says "Run and pass
make lint" and "Run and passmake test" but does not explain:4. No PR checklist
Many projects include a checklist for:
gofmtI can submit a PR addressing these items if this would be helpful.
Related: #1166 (improve documentation quality)