README.en-US.md

Github Repository Template

Background | Introduction | Usage | Examples | Related Efforts | Maintainers | Contributing | License | 中文

Background

You can generate a new repository with the same directory structure and files as an existing repository. If you have some idea, welcome to discussion.

GitHub Template Docs

Introduction

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

   A text file containing information about the files in a repository that is typically the first file a visitor to your repository will see. A README file, along with a repository license, contribution guidelines, and a code of conduct, helps you share expectations and manage contributions to your project.

2. README.en-US.md

   README use English.

3. LICENSE

   A document that you can include with your project to let people know what they can and can't do with your source code.

4. .gitignore

   A gitignore file specifies intentionally untracked files that Git should ignore. Files already tracked by Git are not affected; see the NOTES.

5. CHANGELOG.md

   Every time a new version is released, record the changed features of the new version, as well as the modified bug and other information.

6. CONTRIBUTING.md

   Contribution specifications, such as code writing specifications, if you ask questions, raise bugs, raise requirements, how to write documents, etc.

7. .github/COMMIT_CONVERTION.md

   git commit information specification.

8. .github/PULL_REQUEST_TEMPLATE.md

   the template of pull request.

9. .github/ISSUE_TEMPLATE/bug_report.md

   the template of raise bug in issue.

10. .github/ISSUE_TEMPLATE/custom.md

    custom issue template.

11. .github/ISSUE_TEMPLATE/feature_request.md

    the template of raise requirement in issue.

12. .github/workflows/main.yml

    GitHub Action profile.

Usage

clickbutton，create a standard github repository quickly。

or use GitHub cli gh

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

Examples

Generally, the open source repository need to have some examples or codes for users' reference.

Related Efforts

• standard-readme — A standard style for README files.
• Angular.js — The CONTRIBUTING of Angular.js.

Maintainers

@BruceMaa。

Contributing

Feel free to dive in or submit PRs。

Github-Repository-Template follows the Contributing specification。

Github-Repository-Template follows the Contributor Covenant Code of Conduct。

License

MIT © Bruce Maa.