Edit

Configuration de bot

Vous pouvez configurer le comportement de bot all-contributors en mettant à jour le fichier JSON .all-contributorsrc. The data used to generate the contributors list will be stored there, and you can configure how you want @all-contributors to generate the list.

Vous être en train de voir la Configuration du 🤖Bot, qui est similaire à la configuration CLI

Voici les clés, que vous pouvez spécifier :

OptionDescriptionExemple/Défaut
projectNameObligatoire, nom du projet.Exemple : all-contributeurs-cli
projectOwnerObligatoire, le nom de l’utilisateur qui héberge le projet.Example: tenshiAMD
repoTypeType de répertoire. Doit être github ou gitlab.Par défaut : github
repoHostPointe vers le nom d’hôte du répertoire. Changez-le si vous utilisez un répertoire auto-hébergé.Par défaut : https://github.com si repoType est github et https://gitlab.com si repoType est gitlab
filesTableau de fichiers à mettre à jour.Par défaut : ['README.md']
imageSizeTaille (en px) d’avatar de l’utilisateur.Par défaut : 100
commitEnvoyer automatiquement l'insigne lorsque vous ajoutez des contributeurs.Par défaut : false
commitConventionCommit convention (angular, atom, ember, eslint, jshint, gitmoji, or none).Default: angular
contributorsPerLineNombre maximum de colonne pour la table de contributeurs.Par défaut : 7
contributorsSortAlphabeticallytrue: Sort alphabetically. false: Display in order of addition.Par défaut : false
badgeTemplateDéfinir votre propre modèle lodash pour générer le badge.
contributorTemplateDéfinir votre propre modèle lodash pour générer le badge.
wrapperTemplateDefine your own lodash template to wrap the list of contributors
typesSpécifier des symboles personnalisés ou lier des modèles pour les types de contribution. Peut substituer les types documentés.
linkToUsageAdds a footer with link to usage (either true or false)Default: true
skipCiMakes the CI ignore the commit. (either true or false)Default: true
contributorsListe des contributeurs pour ceux projet, c’est mis à jour par @all-contributors add
 
{
  "projectName": "all-contributors",
  "projectOwner": "all-contributors",
  "repoType": "github",
  "repoHost": "https://github.com",
  "files": ["README.md"],
  "imageSize": 100,
  "commit": false,
  "contributorsPerLine": 7,
  "contributorsSortAlphabetically": false,
  "badgeTemplate": "[![All Contributors](https://img.shields.io/github/all-contributors/<%= projectOwner %>/<%= projectName %>?color=ee8449&style=flat-square)](#contributors)",
  "contributorTemplate": "<a href=\"<%= contributor.profile %>\"><img src=\"<%= contributor.avatar_url %>\" width=\"<%= options.imageSize %>px;\" alt=\"\"/><br /><sub><b><%= contributor.name %></b></sub></a>",
  "wrapperTemplate": "\n<table>\n  <tbody><%= bodyContent %>  </tbody>\n<%= tableFooterContent %></table>\n\n",
  "types": {
    "custom": {
      "symbol": "🔭",
      "description": "A custom contribution type.",
      "link": "[<%= symbol %>](<%= url %> \"<%= description %>\"),"
    }
  },
  "linkToUsage": true,
  "skipCi": true,
  "contributors": []
}

Moving the All Contributors table into a different file

As you know, the default file for the contributors table is README.md. But if your project has tons of contributors, it doesn't make sense to include the All Contributors table in the README.md file. Instead, you can use a different file to do so.

Here are the steps that may help you in achieving that. For the sake of this tutorial, the different file that we'll use is going to be named CONTRIBUTORS.md.

  1. Install the bot. See the Installation page for instructions.

  2. Add your first contributor. See the Bot Usage page for instructions.

  3. Create the CONTRIBUTORS.md file.

  4. Copy the code which can be found in this guide.

  5. Modify the files key in the .all-contributorsrc JSON file to match your new file name.

    {
"files": [
  "CONTRIBUTORS.md"
],
...
}

  6. Now you should be good to go. New contributors will be added to this new file instead of the README.md file.

← UtilisationFAQs →