InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
Acknowledging all contributions/contributors
Nessuno ha ancora preso questa issue.
- Lingua principale
- HTML
- Stelle
- 853
- Fork
- 206
- Merge medio
- 1g 23h
- PR unite (30g)
- 2
Descrizione
GitHub has a way to show the people that committed (code) to this project. However by default only very few people are shown, and there is no further information about what they have contributed either.
As our community grows, it would be great to acknowledge the broad range of people that are supporting our patterns in all sorts of ways, not just the ones contributing code/patterns.
Implementation thoughts
I have heard good things about the all-contributors spec and bot but I don't know how it works in practice.
Their claim is:
Recognize All Contributors - Including those that don't push code
However their documentation looks like users need a GitHub handle to be added as contributors, which seems counter intuitive.
I am taking inspiration from The Turing Way project, who are using the tool for years.
We could review their implementation notes. Some links to get started:
- https://github.com/alan-turing-institute/the-turing-way/blob/main/contributors.md#record-of-contributions
- https://github.com/alan-turing-institute/the-turing-way/blob/main/CONTRIBUTING.md#recognising-contributions
- https://github.com/alan-turing-institute/the-turing-way/issues/274
- https://github.com/alan-turing-institute/the-turing-way/issues/446
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
Leggi le sezioni collegate di contributors.md e CONTRIBUTING.md di Turing Way, quindi esamina la specifica di all-contributors e la documentazione del bot. Determina come questo progetto dovrebbe rappresentare i contributi al codice e quelli non relativi al codice, inclusi i contributori senza handle GitHub. Il lavoro è completato quando l’approccio di riconoscimento scelto e il relativo processo di manutenzione sono concordati e documentati.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- github
- Ambito
- documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 25/100