如何感谢GitHub上的贡献者?
10 月底,我发起了一个 GitHub 项目来列出不同的南特社区。捐款很快就到了💪🙏!与大多数开源项目一样,致谢是通过列出贡献者来完成的,这是我能做的最起码的感谢他们。 我没有在每个贡献上手动进行并找到一个很酷的图形表示,而是做了一些研究并很快遇到了这个机器人all-contributor。它允许您在文件中列出贡献者,默认情况下为 README.md,以及他们的 GitHub ID 和个人资料
10 月底,我发起了一个 GitHub 项目来列出不同的南特社区。捐款很快就到了💪🙏!与大多数开源项目一样,致谢是通过列出贡献者来完成的,这是我能做的最起码的感谢他们。
我没有在每个贡献上手动进行并找到一个很酷的图形表示,而是做了一些研究并很快遇到了这个机器人all-contributor。它允许您在文件中列出贡献者,默认情况下为 README.md,以及他们的 GitHub ID 和个人资料图片。机器人还以计数器的形式显示贡献者的数量。
[](https://res.cloudinary.com/practicaldev/image/fetch/s--4ugAZ3io--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_880/http : //jeanphi-baconnais.gitlab.io/img/botgithub-nb-contrib.png)
[](https://res.cloudinary.com/practicaldev/image/fetch/s--2QcZDjdl--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_880/http://jeanphi -baconnais.gitlab.io/img/botgithub-contributors.png)
这个结果是通过_pull requests_获得的,机器人已经自动创建了以下命令,项目维护者放置在问题或拉取请求中。
@all-contributors please add @<pseudo-github> for <something>
允许您请求机器人并通过他们的 GitHub 昵称为他们执行的操作添加一个人(在示例中由 表示)。所有贡献者提供的操作列表在此页面上列出:https://allcontributors.org/docs/fr/emoji-key。
机器人检测到这个短语,自动创建一个拉取请求以增加贡献者的数量,并将贡献者的姓名和个人资料图片添加到贡献者表中。快速简单!
[交互的图解](https://res.cloudinary.com/practicaldev/image/fetch/s--Ifj2F-zD--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_880/ http:// /jeanphi-baconnais.gitlab.io/img/botgithub-bot.png)
在 README.md 中,这两个部分必须能够被机器人识别,这通过_tags_ 发生:
对于计数器,只需设置:
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
<!-- ALL-CONTRIBUTORS-BADGE:END -->
进入全屏模式 退出全屏模式
对于贡献者表:
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
进入全屏模式 退出全屏模式
机器人正是利用这些信息找到要修改的位置。
如果您想在主 README.md 之外的另一个文件中显示此信息,这是可能的。机器人基于配置文件.all-contributorsrc
放置在您的项目中。此文件用于输入要输入贡献的文档的名称、个人资料照片的大小、每行的贡献者数量以及每个贡献者的显示模板。这是一个基本示例:
{
"files": [
"README.md"
],
"imageSize": 100,
"contributorsPerLine": 7,
"contributorsSortAlphabetically": false,
"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 %>\"),"
}
},
"skipCi": true,
"contributors": [],
"projectName": "xxxx",
"projectOwner": "xxxxx",
"repoType": "github",
"repoHost": "https://github.com"
进入全屏模式 退出全屏模式
💡 如果您的项目中有 CI,请记住将值“true”设置为“skipCi”参数,这样可以节省您的处理时间。
命令行界面 (CLI) 也可用。可通过 npm 或 yarn 像任何库一样安装,然后使用此命令yarn all-contributors add <pseudo-github> <something>
添加贡献者。
一个易于安装和使用的机器人,可让您正确地感谢您的贡献者💪
i️ 更多信息,这里是项目文档页面:https://allcontributors.org/docs/en/overview
更多推荐
所有评论(0)