github

在一个开源的 GitHub 仓库中，除了 README.md 之外，还有很多非必要但非常有价值的文件，可以帮助项目推广、获得认可、吸引贡献者、提升专业度、方便开发协作等。下面列出常见的此类文件及其作用和通常的位置：

---

1. 项目推广与认可相关

• LICENSE
  说明项目的开源许可证，帮助别人合法使用和贡献。
  位置：项目根目录

• CONTRIBUTING.md
  贡献指南，告诉开发者如何参与贡献（如提 PR、提 Issue、代码规范等）。
  位置：项目根目录或 .github/

• CODE_OF_CONDUCT.md
  行为准则，营造友好社区氛围，提高项目专业度。
  位置：项目根目录或 .github/

• FUNDING.yml
  支持项目的资助信息（如 GitHub Sponsors、Open Collective 等）。
  位置：.github/FUNDING.yml

• SECURITY.md
  安全报告指南，说明如何报告安全漏洞。
  位置：项目根目录或 .github/

• .all-contributorsrc
  用于 All Contributors 项目，自动生成贡献者列表，增强认可感。
  位置：项目根目录

---

2. 开发协作与帮助相关

• ISSUE_TEMPLATE/
  Issue 模板，帮助用户规范反馈 bug 或提建议。
  位置：.github/ISSUE_TEMPLATE/

• PULL_REQUEST_TEMPLATE.md
  PR 模板，规范 Pull Request 流程。
  位置：项目根目录或 .github/

• CHANGELOG.md
  变更日志，记录每个版本的主要变更，方便用户和开发者了解历史。
  位置：项目根目录

• ROADMAP.md
  未来规划，说明项目接下来的发展方向。
  位置：项目根目录

• docs/
  更详细的文档目录，适合大型项目。
  位置：项目根目录 docs/

---

3. CI/CD 与开发环境支持

• .github/workflows/
  GitHub Actions 工作流，自动化测试、部署等。
  位置：.github/workflows/

• .editorconfig
  统一不同编辑器的代码风格。
  位置：项目根目录

• .gitattributes / .gitignore
  Git 配置文件，控制文件提交和属性。
  位置：项目根目录

---

4. 社区互动与联络

• SUPPORT.md
  告诉用户如何获得帮助。
  位置：项目根目录或 .github/

• DISCUSSION.md
  介绍 Discussions 的用法或社区讨论入口。
  位置：项目根目录或 .github/

---

5. 徽章与项目状态展示

• Badges
  在 README.md 顶部添加 CI 状态、版本、License、贡献者等徽章，提升专业度和可见性。
  位置：README.md 中

---

6. 本地化与多语言支持

• .github/ISSUE_TEMPLATE/config.yml
  支持多语言 Issue 模板。
  位置：.github/ISSUE_TEMPLATE/

• README_zh.md、README_en.md 等
  提供多语言文档，方便不同地区用户。
  位置：项目根目录

---

总结

常见位置：

• 项目根目录
• .github/ 目录（专门放与 GitHub 相关的配置和文档）

这些文件不是强制要求，但能：

• 提升项目专业度和可信度
• 吸引开发者参与
• 规范协作流程
• 增加项目曝光和社区认可