Edit

规范

下图是一个使用 all-contributors 规范表来致谢所有贡献者的例子。

贡献者表格截图

必选项

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

  1. 项目“贡献者”部分应该包括所有的贡献者，并将其展现在项目文档的显眼位置。
    • 在允许的情况下，将贡献者列表展示在项目文档的显眼位置。 许多情况下，为项目的 README 文件。
    • 当项目贡献者数量太多时，可能不适合直接使用 README 文件致谢，此时请考虑在项目仓库跟目录下创建 CONTRIBUTORS 文件。 在这种情况下，指向 CONTRIBUTORS 文件的链接应该包含在 README 页面里“Contributor”标题下。
  2. 以表格形式展现所有项目贡献者的信息：
    • 名字
    • 网站超链接，用于查看更多有关贡献者的信息。 该超链接可由贡献者根据项目自行决定。
    • 文本或图像格式的贡献指示，要求使用贡献目录中规定的贡献类别文本或 emoji 表情（见下文）。
    • 文本或图像格式的贡献指示中的超链接，指向相关的贡献目录。要求使用贡献目录中规定的贡献类别文本或 emoji 表情。
      • The list of contributors can be spread across multiple lines (each technically being its table) as needed.
      • 贡献者的顺序并不重要。 按照你的意愿排序。
  3. 贡献者被定义为，在项目中为之付出过参与者，无论贡献大小与重要程度。 因此，在说明中应该包括所有的贡献者。 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. 本规范建议，不要根据感性认知来确定个人的贡献水平。 相反，项目应该使用列表中的贡献指示来标定所有贡献者的努力，无论贡献大小和重要程度。 如果使用，这些贡献指标将由项目酌情决定，目前没有尚未明确。

专业提示：你可以使用@all-contributors bot 🤖自动识别你开源项目的贡献者。

可选项

项目应该考虑以下可选项，作为其对All Contributors规范的承诺的一部分：

  1. 用户头像可以被包括，并且是推荐的。
  2. 可以加入包括从贡献指示到特定类别贡献的可选链接，以提供有关项目贡献的其他信息，详见下一节。

接下来呢？

← 概览Emoji键 ✨ →