This project focuses on automating the creation and maintenance of crucial community health files in GitHub repositories. These files are instrumental in guiding contributors, maintainers, and users on best practices, project guidelines, and code of conduct. By offering standardized templates, the project ensures that all participating repositories possess the necessary resources to maintain a positive and respectful environment for all stakeholders.
- Issue Templates and configuration
Bug ReportFeature RequestSupport Question
- Pull Request Template
- Code of Conduct
- Contributing
- Security
- Funding
-
Begin your journey by forking this repository to your own GitHub account. Simply click on the "Fork" button at the top-right corner of this page.
⚠️ For the project to work as intended, the forked repository must be named precisely as.githubwith a dot (.) at the beginning and "github" in all lowercase letters. -
Spice up your repository by personalizing the community health files. Tailor the issue templates, pull request template, and code of conduct to resonate with your project's spirit.
-
Create a set of engaging contributing guidelines. Encourage contributors to dance their fingers across the keyboard and become part of your project's rhythm.
-
Fortify your repository's security! Polish the security policy to ensure everyone can safely collaborate and share ideas without any worries.
-
If your project deserves the spotlight, don't forget to add information about funding sources or sponsorship options. Let the world know how they can help support your dreams!
GitHub offers a convenient "Sync" feature that automates the process of updating your forked repository with the latest changes from the original repository. Here's how you can use this feature:
- On GitHub, navigate to the main page of the forked repository named
.githubto sync with the upstream repository. - Select the Fetch upstream drop-down.
- Review the details about the commits from the upstream repository, then click Fetch and merge.
If the changes from the upstream repository cause conflicts, GitHub will prompt you to create a pull request to resolve the conflicts.
For more information, see syncing a fork
By default, if a repository does not contain its custom version of a particular file, the default file provided by this project will be automatically used.
Whenever you create a new repository or want to update an existing repository owned by your GitHub account, simply leave out the specific community health file you wish to be automatically generated. GitHub will detect the absence of the custom file and automatically apply the corresponding default file provided by the `.github`` repository.
For repositories that require unique guidelines or customized community health files, you can always override the default files by adding your tailored versions. The custom files will take precedence over the default ones, providing you the flexibility to cater to specific project needs.
By leveraging the Default GitHub Community Health Files project, you establish a unified and welcoming environment for contributors across all your repositories.
For more information, see creating a default community health file.
If you want to contribute to this project and make it better, your help is very welcome.
For more information, see Contributing Guide.
If you discover a security vulnerability within this project, please follow our Security Policy.
This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.
In no event shall we be liable to you or any third parties for any special, punitive, incidental, indirect or consequential damages of any kind, or any damages whatsoever, including, without limitation, those resulting from loss of use, data or profits, and on any theory of liability, arising out of or in connection with the use of this software.