GitHub allows users and organizations to set default community health files for their projects for easier community management. Instead of maintaining contribution guidelines or security policies across multiple repos, we can create a .github repository to apply one set of community health files to all repositories!
If you want to set your own default community health files using this repository as a guide, simply fork this repostory with the name .github. Just don't forget to change the contact links and email addresses to your own.
If you want to start from scratch, reference the official guide.
-
CONTRIBUTING.md: A simple set of contribution guidelines written in a way that should apply to most of my personal projects.
-
CODE_OF_CONDUCT.md: A 'one size fits all' code of conduct based on the Contributor Covenant.
-
SECURITY.md: A basic security policy that states that all active projects will receive security patches. Meant to be overridden for versioned projects - just use a semantic version like
1.x.xwhere the template uses latest. -
ISSUE_TEMPLATE: Issue templates for bug reports, feature requests, and questions. Includes a configuration disallowing blank issues (i.e. requiring use of issue templates) and a link to my contact form.
-
PULL_REQUEST_TEMPLATE.md: A simple pull request template that encourages the use of Conventional Commits.
- Open Source Guides
- The Contributor Covenant, a code of conduct to help promote a positive community environment
- GitHub's guide on Building a Strong Community
Licensed under the MIT License.