stackabletech / stackabletech/documentation
Create a developer 'Quickstart' page
Nessuno ha ancora preso questa issue.
- Lingua principale
- CSS
- Stelle
- 13
- Fork
- 14
- Merge medio
- 4g 8h
- PR unite (30g)
- 10
Descrizione
As a contributor with maybe some previous knowledge, I don't want to read lenghty instructions on how to get geoing. I want to read a quick page that is mostly shell script commands that I can run to get going.
The goal should be to have a dev environemnt where I can change things in the operator and test it in kind.
steps:
- show how to install the dependencies (
apt install gzip kind kuttl...)- Problem: Lot's of tools, a lot of them installable in a different way, annoying to maintain such a list
- configure git signing
- show how to make changes to an operator
- git clone
- make a change
- run checks (
cargo clippy --all-targets) - run
./scripts/test.sh - Raise PR
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
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.
Direzione di ricerca
Inizia dalla documentazione esistente del repository per i contributori e sullo sviluppo, quindi usa i comandi indicati nell'issue, inclusi cargo clippy --all-targets e ./scripts/test.sh. La pagina è completata quando fornisce una configurazione concisa delle dipendenze e della firma Git, i passaggi per clonare/modificare/verificare/creare un PR e spiega come testare l'operatore in kind.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- git, rust, shell
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100