GitHub仓库中.github/CONTRIBUTING.md文件的作用是什么

文件核心作用 #

不管放在仓库根目录还是.github目录下，CONTRIBUTING.md都是GitHub官方约定的专属贡献指南文件，核心用途是给所有想给仓库提交贡献的开发者提供明确指引：

• 明确贡献准入规则：包括代码风格要求、PR提交规范、commit信息格式、是否需要签署贡献者协议、社区行为准则等要求，避免贡献者提交不符合要求的内容浪费双方时间
• 梳理贡献全流程：写清本地开发环境搭建方式、测试运行方法、Issue提交分类规则、PR评审流程等实操内容，减少维护者反复回答同类问题的沟通成本
• 作为仓库社区规范的公开载体，所有参与项目协作的人都需要遵守文件内列明的规则

.github目录存放的生效规则 #

.github是GitHub官方约定的特殊隐藏目录，用来统一存放所有和仓库社区配置、协作规则相关的文件，除了CONTRIBUTING.md之外，行为准则文件、Issue/PR模板、赞助配置文件都可以放在这个目录下统一管理，不用散落在根目录。
文件识别优先级上，根目录存放的配置文件优先级高于.github目录下的同名文件，如果两个位置同时存在CONTRIBUTING.md，GitHub会优先读取根目录的版本。

前端跳转链接生成规则 #

存放在.github目录下的CONTRIBUTING.md会被GitHub正常识别，在前端对应功能区自动生成可点击的跳转链接，具体入口包括：

• 仓库主页的新访客引导区，会显示贡献指南的跳转入口
• 新建Issue、提交PR的页面顶部，会自动弹出贡献指南提示条，附带直接跳转链接
• 仓库社区标准检查板块，会识别到该文件并标记为已配置，支持点击跳转查看

补充说明：如果是组织账号下的同名.github仓库，在里面存放的CONTRIBUTING.md还会默认对组织下所有未单独配置该文件的仓库生效，不需要每个仓库重复维护相同的贡献规则。

内容的提问来源于stack exchange，提问作者buhtz