Have a look at the GitHub docs that explain what this repo is about.
File | Description |
---|---|
LICENSE | You can include an open source license in your repository to make it easier for other people to contribute. For more information, see "Adding a license to a repository". |
README.md | You can add a README file to your repository to tell other people why your project is useful, what they can do with your project, and how they can use it. For more information, see "About READMEs". |
File | Description |
---|---|
ISSUE_TEMPLATE/xy | You can customize the templates that are available for contributors to use when they open new issues in your repository. For more information, see "About issue templates" and "Configuring issue templates for your repository". |
CODEOWNERS | You can use a CODEOWNERS file to define individuals or teams that are responsible for code in a repository. For more information, see "About code owners". |
CODE_OF_CONDUCT.md | A CODE_OF_CONDUCT file defines standards for how to engage in a community. For more information, see "Adding a code of conduct to your project". |
CONTRIBUTING.md | A CONTRIBUTING file communicates how people should contribute to your project. For more information, see "Setting guidelines for repository contributors". |
FUNDING.yml | A FUNDING file displays a sponsor button in your repository to increase the visibility of funding options for your open source project. For more information, see "Displaying a sponsor button in your repository". |
PULL_REQUEST_TEMPLATE.md | When you add a pull request template to your repository, project contributors will automatically see the template's contents in the pull request body. For more information, see "About pull request templates" and "Creating a pull request template for your repository" |
SECURITY.md | A SECURITY file gives instructions for how to report a security vulnerability in your project. For more information, see "Adding a security policy to your repository". |
SUPPORT.md | A SUPPORT file lets people know about ways to get help with your project. For more information, see "Adding support resources to your project". |
File | Description |
---|---|
README.md | You can share information about your organization by customizing your organization's profile. For more information, see "Customizing your organization's profile". |
Examples of these files can be found on