Imageomics / Imageomics/Collaborative-distributed-science-guide
Clarify commit suggestions
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 1
- Fork
- 1
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
The [Formatting and Naming Conventions](https://imageomics.github.io/Collaborative-distributed-science-guide/wiki-guide/GitHub-Repo-Guide/#formatting-and-naming-conventions) section could use a re-visit. I think we need to elevate the commit portion, but also make it more in-line with practice. We should summarize the purpose of commit messages, highlighting important aspects of readability and understanding processes done. Then also link to good practices for, e.g., machine-readability and such, but the ultimate goal of understandable commits (why is this change happening) needs to be expressed clearly.
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 dalla sezione collegata «Formatting and Naming Conventions» del Collaborative Distributed Science Guide e verifica le indicazioni attuali sui commit. Il lavoro è completato quando la sezione spiega chiaramente lo scopo dei messaggi di commit, la leggibilità e la comprensione del lavoro svolto, rimanda a buone pratiche per commit leggibili dalle macchine ed enfatizza il motivo per cui vengono apportate le modifiche.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- git
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- Mezza giornata
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100