使用all-contributors机器人记录开源项目贡献者

开源项目的协作十分重要,应该尊重每一个贡献者的劳动成果。all-contributors 项目提供了一个易于使用的 bot,帮助我们轻松将每个贡献者记录到项目之中。

首先安装 bot,https://github.com/apps/allcontributors/installations/new

之后新开一个 issue,在里面输入以下指令就可以让 bot 自动创建 PR,将贡献者添加进来了。默认会在项目README.md文件中添加贡献者,所以需要该文件存在(内容可以为空)。或者如果贡献者太多的话,可以考虑将贡献者放到CONTRIBUTORS.md中,而在项目 README 醒目位置添加该文件的链接。

其中<contributions>是贡献类别,这里有详细说明https://allcontributors.org/docs/en/emoji-key

1
2
3
@all-contributors please add @<username> for <contributions>
# 例
@all-contributors please add @techstay for example

推荐同时在项目中添加CONTRIBUTING.md或类似文件,里面介绍向项目发起贡献的方法,甚至可以将 all-contributors 的文档链接也带上。

如果需要修改 bot 配置的话,编辑 bot 添加的.all-contributorsrc文件即可,可以参考https://allcontributors.org/docs/zh-cn/overview

Licensed under CC BY-NC-SA 4.0
comments powered by Disqus
本站总访问量次,总访客数人,当前页面总访问量
Built with Hugo
主题 StackJimmy 设计