https://github.com/githubtraining/repository-template
A general purpose repository template with some starter issue and PR templates and workflows
https://github.com/githubtraining/repository-template
Last synced: 8 months ago
JSON representation
A general purpose repository template with some starter issue and PR templates and workflows
- Host: GitHub
- URL: https://github.com/githubtraining/repository-template
- Owner: githubtraining
- Archived: true
- Created: 2021-10-21T15:38:24.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-10-21T15:38:59.000Z (over 4 years ago)
- Last Synced: 2025-03-14T07:21:19.264Z (11 months ago)
- Size: 15.6 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
- Support: SUPPORT.md
Awesome Lists containing this project
README
# GitHub Repository Template
## Background
This template repository is intended to give you some resources
to get your project set up to be secure, maintainable, and supportable
right from the start, and to help the project to follow organization guidelines.
You can create a new repository using this template by clicking the "Use this template"
button at the top of the repository file list.
[Here is the GitHub documentation on using repository templates](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template)
## What is included
- [Issue templates](https://docs.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository),
- [Pull Request templates](https://docs.github.com/en/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository),
- [`.gitignore`](https://docs.github.com/en/github/using-git/ignoring-files)
- [`.editorconfig`](https://editorconfig.org/)
- [`.gitattributes`](https://github.com/alexkaratarakis/gitattributes/blob/master/Common.gitattributes)
- A starter [`README.md`](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-readmes#about-readmes) - this is the document that you are reading!
- Here are some ([good examples of READMEs](https://github.com/matiassingers/awesome-readme))
- [Some community and contribution guidelines]((https://docs.github.com/en/github/building-a-strong-community/creating-a-default-community-health-file#about-default-community-health-files))
- [Contribution guidelines (`CONTRIBUTING.md`)](https://docs.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors) for the project
- A [`CODE_OF_CONDUCT.md`](https://docs.github.com/en/github/building-a-strong-community/adding-a-code-of-conduct-to-your-project) with the code of conduct for the project
- A [`SUPPORT.md`](https://docs.github.com/en/github/building-a-strong-community/adding-support-resources-to-your-project) file to show how to get support
- A [`SECURITY.md`](https://docs.github.com/en/github/managing-security-vulnerabilities/adding-a-security-policy-to-your-repository) file containing the security policy
- A [Dependabot config file](https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates) for alerting on dependency vulnerabilities
- A [CODEOWNERS file](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners) with a commented out example of all code owned by the same team
- Some starter [GitHub Actions workflows](https://docs.github.com/en/actions/learn-github-actions)
- [Stale issue](https://github.com/actions/stale) - labels and closes issues and pull requests with no activity for a set period of time
- [Super Linter](https://github.com/github/super-linter) - uses language-specific linting rules to analyze repository code
- [LFS Warning](https://github.com/ActionsDesk/lfs-warning) - issues warnings when large files are added to the repository
- [CodeQL](https://github.com/github/codeql-action) - scans repository code for security vulnerabilities and creates alerts
- [Release Drafter](https://github.com/marketplace/actions/release-drafter) - drafts release notes based on merged pull requests
- [First Interaction](https://github.com/actions/first-interaction) - Greets new contributors to the repo
## How to Use
All the resources provided in this repository are meant
to provide you with a quick start, but as your project
grows and evolves, please update the templates, workflows,
and community health files to better reflect the specific
needs of the project and the community that grows around it.
## Feedback
Please contact the admin team for GitHub with any feedback and suggestions.