Creating A Default Neighborhood Well Being File - GitHub Docs

You can add default group health recordsdata to a public repository called .github, in the root of the repository or within the docs or .github folders.

GitHub will use and show default recordsdata for any repository owned by the account that doesn't have its own file of that kind in any of the following locations:

- the root of the repository
- the .github folder
- the docs folder

For example, anyone who creates a difficulty or pull request in a repository that does not have its personal CONTRIBUTING file will see a hyperlink to the default CONTRIBUTING file. If a repository has any information in its own .github/Difficulty_TEMPLATE folder, together with concern templates or a config.yml file, none of the contents of the default .github/Problem_TEMPLATE folder will likely be used.

Default files are usually not included in clones, packages, or downloads of individual repositories because they are saved only in the .github repository.

Supported file types

You can create defaults in your organization or person account for the next neighborhood well being information:

You can not create a default license file. License files must be added to individual repositories so the file can be included when a venture is cloned, packaged, or downloaded.

Creating a repository for default recordsdata

1. In the upper-right nook of any web page, use the drop-down menu, and choose New repository.
2. Use the Proprietor drop-down menu, and choose the group or consumer account you want to create default files for.
3. Sort .github as the identify for your repository, and an optionally available description.
4. Ensure that the repository status is set to Public (a repository for default files cannot be non-public).
5. Choose Initialize this repository with a README.
6. Click on Create repository.
7. In the repository, create one of many supported neighborhood well being files. Difficulty templates and their configuration file must be in a folder called .github/Challenge_TEMPLATE. All different supported information may be in the foundation of the repository, the .github folder, or the docs folder.