Edit

Spécification

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

Capture d’écran de Table de contributeurs

Obligatoire

Open source projects should include the following mandatory items to support the All Contributors specification:

  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. Dans de nombreux cas, il s'agit du fichier README du projet
    • 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).
    • Un lien vers la catégorie de contribution en format de texte ou d'emoji en utilisant les catégories de contribution définies et/ou Catégories de Contribution emoji.
      • The list of contributors can be spread across multiple lines (each technically being its table) as needed.
      • 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. In cases where projects deviate from the Contribution Categories or require a specific contribution level to meet criteria as a project contributor, the project should provide explicit documentation of the definitions that satisfy the project contributor criteria in the CONTRIBUTING document or a similar prominent public document at the top level of the project repository. 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.

Conseil de pro: Vous pouvez utiliser le bot @all-contributors 🤖 pour automatiquement reconnaitre des contributeurs à votre projets à source ouverte ✨

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.

Et ensuite

← AperçuClé d'Emoji ✨ →