codrsquad / codrsquad/portable-python
Request: More detailed documentation about the configuration file
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 86
- Fork
- 13
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
This repository has a very high code quality and very decent output.
I notice this portable-python package is quite configurable, but I can't find any documentation about it, and have to read the source code and test cases. It is not very efficient and a little painful.
Is that possible to add more documentation about portable-python.yaml?
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 esaminando il codice sorgente e i casi di test che definiscono portable-python.yaml, quindi documenta le opzioni di configurazione disponibili e il loro utilizzo. Il lavoro è completato quando gli utenti possono comprendere e configurare il pacchetto senza dover esaminare il codice sorgente o i test.
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-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100