line / line/centraldogma-python
Add simple examples to README.md
Aperta
Nessuno ha ancora preso questa issue.
documentation
- Lingua principale
- Python
- Stelle
- 21
- Fork
- 11
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
README.md could be a gentle guide for users to start centraldogma-python for the first time.
Examples:
https://github.com/line/centraldogma-go
https://github.com/line/centraldogma-rs
Guida per i contributori
Apri 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.
Direzione di ricerca
Inizia da README.md e confronta il materiale introduttivo nei repository collegati centraldogma-go e centraldogma-rs. Aggiungi semplici esempi di primo utilizzo per il client Python, con contesto sufficiente affinché un nuovo utente possa seguirli; il README dovrebbe guidare chiaramente attraverso il flusso di configurazione e utilizzo iniziale.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100