docs: update CONTRIBUTING.md — stale branch reference and missing dev setup
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 75/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Tranquilla
- Stack tecnologico
- docker, go, kubernetes
- Ambito
- developer-experience, documentation
Direzione di ricerca
L'issue punta a CONTRIBUTING.md. Inizia leggendo quel file per comprendere la struttura attuale. Cerca la riga che fa riferimento a 'master' e prendi nota delle sezioni che necessitano di espansione. Controlla la root del repository per un Makefile per vedere i comandi disponibili come 'make lint' e 'make test'. Rivedi eventuali guide di configurazione di sviluppo esistenti o file README per raccogliere dettagli sulla versione di Go, Docker e i requisiti di Kustomize. L'obiettivo è aggiornare il documento con nomi di branch accurati e aggiungere le istruzioni di configurazione e test mancanti.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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)
- Lingua principale
- Go
- Stelle
- 1.3k
- Fork
- 111
- Merge medio
- 2g 12h
- PR unite (30g)
- 2
Preparare l'ambiente
- Include un Dockerfile o un file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di KusionStack/kusion
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 30/100
KusionStack/kusion#1467 ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 10/100
KusionStack/kusion#1448 ·
-
Feat: AI-coding/vibe-coding support for writing Kusion modulesForse di nuovo libera @ruquanzhao l’ha presa 476 giorni fa e non c’è nessuna pull request aperta. Apertakind/feature
KusionStack/kusion#1436 · 1 reazione · 1 assegnatario ·
-
kind/feature
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
KusionStack/kusion#1431 ·
-
Feat: Kusion x RayApertakind/feature priority/important-longterm
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
KusionStack/kusion#1415 ·
Tutte le issue di KusionStack/kusion
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
containerd/containerd#14476 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
kind/bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
ome-projects/ome#1242 ·
I maintainer di solito rispondono entro 1 giorno
-
copy design-review mac P3
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
tosunlab/hisarapp-core#510 ·