InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
Acknowledging all contributions/contributors
Personne n'a encore pris cette issue.
- Langage dominant
- HTML
- Étoiles
- 853
- Forks
- 206
- Merge moyen
- 1 j 23 h
- PR mergées (30 j)
- 2
Description
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
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Lisez les sections liées de contributors.md et de CONTRIBUTING.md de Turing Way, puis examinez la spécification de all-contributors et la documentation du bot. Déterminez comment ce projet devrait représenter les contributions de code et les contributions qui ne sont pas du code, y compris les contributeurs sans identifiant GitHub. La tâche est considérée comme terminée lorsque l’approche de reconnaissance choisie et son processus de maintenance sont convenus et documentés.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- github
- Domaine
- documentation
- Type d'issue
- Fonctionnalité
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 25/100