GitHub回购指南

所需的物品

所有GitHub存储库都应该具备以下项目，以供外部贡献者充分使用。

文件

• / .github CODEOWNERS:已定义的代码所有者
  • 关于代码所有者- GitHub帮助
• / .cc-metadata.yml:标准CC元数据YAML文件．
• / CODE_OF_CONDUCT.md:行为守则
  • 请随意使用我们的标准CODE_OF_CONDUCT.md文件从creative commons / .github
    • 为您的项目添加行为准则- GitHub帮助
• /许可证:许可文件。
• / CONTRIBUTING.md贡献:指南
  • 可以是特定于项目的还是我们的标准CONTRIBUTING.md文件从creative commons / .github
  • 为存储库贡献者设置指南- GitHub帮助
• / README.md:给我读信息文件
  • 必须记录如何在本地安装和构建项目，并记录项目和代码结构的高级概述。它还应该链接到任何其他可用的文档。
• 的所有拉请求模板必须包含DCO．

额外的项目

• CI和每当推送新代码(如果适用于项目)时自动运行的代码样式延迟器。
• 至少两个自动化测试(如果适用于项目)。

可选项目

• 问题的模板．GitHub从我们的.github存储库自动的，但是如果您想/需要定制它们，可以在存储库中创建它们。
• 一个把请求模板．GitHub从我们的.github存储库自动的，但是如果您想/需要定制它，请在存储库中创建它。
• 支持资源．GitHub提取默认值SUPPORT.md文件从我们.github存储库自动的，但是如果您想/需要定制它，请在存储库中创建它。

标准标签

所有的存储库都必须包含一组标准标签，记录在这里，除了特定于存储库的技能标签外，它还包括公共标签。你不需要手动设置这些。标签是自动管理在所有CC存储库上，因此，不能重命名。

存储库还可能包含其他自定义标签，这些标签将不受同步的影响。建议在该项目的贡献指南中解释自定义标签。

分支的保护

分支保护由CC员工通过自动设置creative commons / ccos-scripts．默认情况下，直接推送到默认的分支(交货。主要)被禁用，所有的pull请求在合并前都需要至少一个人的审查。

CC元数据文件

每个回购都应该有一个.cc-metadata.yml根目录下的文件，结构如下:

#这个GitHub回购是否为cc领导的工程项目engineering_project：真正的#存储库/项目的英文名称english_name：CC目录API#使用的所有技术技术：Python, Django, Django REST Framework, Elasticsearch#这个存储库是否应该出现在CC开源网站的“项目”页面上特色：假# Slack频道名称(可选键)松弛：“cc-dev-catalog”

元数据文件用于项目页面。标记为非工程项目的回购不会显示在页面中，而标记为特色的回购则与页面顶部显示的一样。如果我们正在积极寻找社区贡献，并有足够的带宽快速审查，回购应该被标记为特色。

没有此元数据文件的回购被视为engineering_projects:真，特色:假而且松:“”．默认是必要的，因为我们需要时间来清理和添加元数据到所有的回购。