Github 仓库模板

背景 | 介绍 | 使用 | 示例 | 相关仓库 | 维护者 | 如何贡献 | 协议 | English

背景

您可以生成具有与现有仓库相同的目录结构和文件的新仓库。如果有什么想法，欢迎来讨论。

GitHub 说明地址

介绍

github-repository-template
├── .github
│   ├── COMMIT_CONVENTION.md
│   ├── ISSUE_TEMPLATE
│   │   ├── bug_report.md
│   │   ├── custom.md
│   │   └── feature_request.md
│   ├── PULL_REQUEST_TEMPLATE.md
│   └── workflows
│       └── main.yml
├── .gitignore
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── README.en-US.md

详细介绍

1. README.md

   自诉文件，包含仓库中文件相关信息的文本文件，通常是仓库访问者看到的第一个文件。自述文件连同仓库许可证、参与指南以及行为准则，帮助您交流要求和管理项目的参与。

2. README.en-US.md

   自诉文件英文版。

3. LICENSE

   许可，一种可随附于项目的文档，告知们能够对您的源代码执行哪些操作，不能执行哪些操作。

4. .gitignore

   gitignore文件指定Git应该忽略的故意未跟踪的文件。 Git已经跟踪的文件不受影响； 有关详细信息，请参见链接。

5. CHANGELOG.md

   每次发布新版本时，记录新版本变化的特性，以及修改的bug等信息。

6. CONTRIBUTING.md

   贡献规范，比如代码编写规范，如果提问题、提bug、提需求，如何编写文档等。

7. .github/COMMIT_CONVENTION.md

   git提交信息规范。

8. .github/PULL_REQUEST_TEMPLATE.md

   提交pull request模版。

9. .github/ISSUE_TEMPLATE/bug_report.md

   在issue中提bug的模版。

10. .github/ISSUE_TEMPLATE/custom.md

    自定义issue模版。

11. .github/ISSUE_TEMPLATE/feature_request.md

    在issue中提需求的模版。

12. .github/workflows/main.yml

    GitHub Action配置文件，可以配置仓库的CI/CD。

使用

点击按钮，一键生成标准GitHub仓库。

或者使用gh命令行创建项目

gh repo create myRepository -p GitHubTemplates/github-repository-template

示例

一般开源项目的仓库，都需要有一些示例说明或者代码，供使用者参考。

相关仓库

• standard-readme — 一个标准README样式建议的仓库。
• Angular.js — Angular.js仓库贡献的编写规范

维护者

@BruceMaa。

如何贡献

非常欢迎你的加入！提一个 Issue 或者提交一个 Pull Request。

Github-Repository-Template 遵循 Contributing 编写规范。

Github-Repository-Template 遵循 Contributor Covenant 行为规范。

协议

MIT © Bruce Maa.