docs: update CONTRIBUTING.md — stale branch reference and missing dev setup
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 75/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- docker, go, kubernetes
- Domain
- developer-experience, documentation
Research direction
The issue points to CONTRIBUTING.md. Start by reading that file to understand the current structure. Look for the line referencing 'master' and note the sections that need expansion. Check the repository's root for a Makefile to see available commands like 'make lint' and 'make test'. Review any existing development setup guides or README files to gather details about Go version, Docker, and Kustomize requirements. The goal is to update the document with accurate branch names and add missing setup and testing instructions.
Written by the indexing model from the issue text.
Description
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)
- Dominant language
- Go
- Stars
- 1.3k
- Forks
- 110
- Avg merge
- 10h 43m
- Merged PRs (30d)
- 1
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing 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.
More from KusionStack/kusion
-
Difficulty 3/5 1-2 days Newbie friendliness 30/100
KusionStack/kusion#1467 ·
-
CI pinned to Go 1.22 and golangci-lint v1.56.2 blocks all Go dependency updatesPossibly taken @Iamrushabhshahh claimed this 1 day ago. Open
Difficulty 4/5 3-5 days Newbie friendliness 18/100
KusionStack/kusion#1462 · 2 comments ·
-
Difficulty 5/5 Over a week Newbie friendliness 10/100
KusionStack/kusion#1448 ·
-
Feat: AI-coding/vibe-coding support for writing Kusion modulesMay be free again @ruquanzhao claimed this 465 days ago, and no pull request is open. Openkind/feature
KusionStack/kusion#1436 · 1 reaction · 1 assignee ·
-
kind/feature
Difficulty 5/5 Over a week Newbie friendliness 25/100
KusionStack/kusion#1431 ·
All issues in KusionStack/kusion
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
documentation hacktoberfest priority: low skill: good first issue status: ready for dev
Difficulty 2/5 Half a day Newbie friendliness 85/100
hyperledger-labs/fabric-smart-client#2142 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
numberly/vault-db-injector#107 ·
Maintainers usually reply within 1 day
-
area/import kind/bug
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Maintainers usually reply within 1 day
-
[DOC] Wrong sg_egress_ports range in the Terraform Databricks Guide for AWS Hub & Spoke with Network FirewallPossibly taken @akhil9tiet claimed this today. Opendocs
Difficulty 1/5 Under an hour Newbie friendliness 72/100
databricks/terraform-provider-databricks#6080 · 1 comment ·
Maintainers usually reply within 3 days