InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
Acknowledging all contributions/contributors
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- HTML
- Sterne
- 853
- Forks
- 206
- Ø Merge
- 1 T. 23 Std.
- Gemergte PRs (30 T.)
- 2
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Lesen Sie die verlinkten Abschnitte in contributors.md und CONTRIBUTING.md von Turing Way und prüfen Sie anschließend die Spezifikation von all-contributors und die Bot-Dokumentation. Ermitteln Sie, wie dieses Projekt Code- und Nicht-Code-Beiträge darstellen sollte, einschließlich Beitrender ohne GitHub-Handles. Als abgeschlossen gilt die Aufgabe, wenn der gewählte Ansatz zur Anerkennung und dessen Pflegeprozess vereinbart und dokumentiert sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- github
- Bereich
- documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100