Spécification

Un exemple de comment utiliser le tableau technique de all-contributors peut reconnaître tous les contributeurs

Obligatoire

Les projets open source devraient comprendre les éléments obligatoires suivants afin de supporter la spécification de All Contributors:

1. Une section “Contributeurs” dans un site bien en vue de la documentation du répertoire du projet qui comprend une liste de tous les contributeurs du projet
   • Le but devrait être d’utiliser le site le plus en vue de la documentation du projet quand cela est faisable. In many cases, this is the project README.md file
   • Consider using a CONTRIBUTORS file in the top level of the repository when the number of project contributors exceeds a level at which it is unfeasible to use the README file to acknowledge contributions. Dans ce cas, un lien proéminent vers le fichier CONTRIBUTEURS devrait être inclus sur la page README sous la rubrique “Contributeurs”
2. Les listes devraient être formatées sous forme de tableau contenant les informations suivants sur les contributeurs du projet:
   • Nom
   • Lien URL vers un site où l’on peut en apprendre davantage sur le contributeur. Cette URL peut être déterminée par le contributeur à la discrétion du projet.
   • Une indication de la catégorie de contribution en format de texte ou d’icône à l’aide des catégories de contribution et/ou des catégories de contribution définies en images emoji (voir ci-dessous).
   • A link to the Contribution Category in text or emoji format using the defined Contribution Categories and/or Contribution Categories emoji.
     • La liste de contributeurs peut être mises sur plusieurs lignes (chacune étant techniquement sa propre table) si besoin.
     • L’ordre de contributeurs est immatériel pour la spécification. Ordonner les comme vous le souhaitez.
3. Les projets devraient définir les contributeurs comme étant ceux qui contribuent à un projet dans n’importe quelle catégorie de contributions à n’importe quel niveau de contribution. Cette spécification comprend, par définition, toutes les contributions. Dans les cas où les projets s’écartent des catégories de contribution ou exigent un niveau de contribution spécifique pour répondre aux critères en tant que contributeur du projet, le projet devrait fournir une documentation explicite des définitions qui satisfont aux critères des contributeurs du projet dans le document CONTRIBUTING ou un document public important similaire au niveau supérieur du référentiel du projet. Cette spécification recommande être contre l’exclusion d’une personne de la liste des contributeurs en fonction du niveau de contribution perçu. Les projets devraient plutôt utiliser des indicateurs d’effort à l’intérieur d’une liste qui inclut tous les contributeurs au projet, peu importe le niveau d’effort. Si utilisé, ces indicateurs d’effort sont à la discrétion du projet et ne sont pas actuellement spécifiés.

Astuce

You can use the @all-contributors bot 🤖 to automate acknowledging contributors to your open source projects ✨

Optionnel

Les projets devraient envisager les éléments facultatifs suivants dans le cadre de leur engagement à l’égard de la spécification de All Contributors:

1. L’avatar de l’utilisateur peut être inclus et c’est recommandé.
2. Un lien facultatif de l’indicateur de la catégorie de contribution jusqu’aux contribution(s) catégories-orientée peut être inclus pour fournir des renseignements supplémentaires sur les contributions du projet, comme il est expliqué dans la section ci-dessous.