如何在GitHub所有贡献者规范的贡献者模板中包含贡献类型徽章?

时间:2020-10-09 02:19:14

标签: html github markdown open-source readme

all-contributors,这是Github机器人的一项服务,用于管理参与者在存储库中的信息。根据指南,仅需要激活该机器人并设置一个名为.all-contributorsrc的JSON文件即可。官方站点提供的示例文件如下。

{
  "projectName": "all-contributors-cli",
  "projectOwner": "jfmengels",
  "repoType": "github",
  "repoHost": "https://github.com",
  "files": ["README.md"],
  "imageSize": 100,
  "commit": false,
  "contributorsPerLine": 7,
  "badgeTemplate": "[![All Contributors](https://img.shields.io/badge/all_contributors-<%= contributors.length %>-orange.svg?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>",
  "types": {
    "custom": {
      "symbol": "?",
      "description": "A custom contribution type.",
      "link": "[<%= symbol %>](<%= url %> \"<%= description %>\"),"
    }
  },
  "contributors": []
}

没有contributorTemplate(它是可选的)属性,它会生成如下的自述文件。

without contributorTemplate

使用contributorTemplate属性,它会生成如下的自述文件。

with contributorTemplate

我只需要删除姓名,并在贡献者的图像中包含贡献徽章即可。

0 个答案:

没有答案