This repository holds community health files and templates for Calibre’s open source and private repositories.
- Code of Conduct
- Contribution Guidelines
- Security Guidelines
- Pull Request Templates
- Issue Templates
- Code Owner Definitions
- Organisation Profile
- Licenses
The CODE_OF_CONDUCT is a critical document outlining our standards and responsibilities in maintaining safe and inclusive spaces for everyone involved. We use Contributor Covenant to communicate the community values and rules. All of our open source repositories should have a Code of Conduct.
🖇 Learn more about CODE_OF_CONDUCT
We use the CONTRIBUTING file to set expectations on how people should contribute to our open source projects. Following the contribution guidelines makes it easier for owners to review issues and pull requests. For contributors, following the guidelines helps avoid improperly created pull requests or issues, so they can get help or review faster. All of our open source repositories should have a Contributing guide.
🖇 Learn more about CONTRIBUTING
The SECURITY file outlines our approach to handling security issues in any of our open source repositories. With a clear disclosure policy, we can triage and respond to vulnerability reports as quickly as possible. Open source repositories should have Security guidelines (where relevant).
We use pull requests to introduce changes in all of our projects. We’ve set up two templates depending on whether the project is private (pull_request_template_private.md) or open source (pull_request_template_oss.md).
⚠️ To use the template, you will have to adjust the name to bePULL_REQUEST_TEMPLATE.md.
🖇 Learn more about PULL_REQUEST_TEMPLATES
We use GitHub’s issue tracking in our open source projects. We’ve set up two templates using issue forms (in beta) in ISSUE_TEMPLATE folder to make creating issues (bug-report.yml) and feature requests (feature-request.yml) easier. When someone opens a new issue, they will be able to choose the option that feels right:
An example of issue templates in action in our React Live Chat Loader repository (see demo).
When working with issue templates, you might want to consider adding any relevant details that aren’t covered by the defaults. All of our open source repositories should have issue templates.
🖇 Learn more about ISSUE_TEMPLATES
We use the CODEOWNERS file to define people (or teams) who are responsible for an entire repository (or a certain area). Thanks to CODEOWNERS, GitHub will automatically request reviews from relevant teammates as pull requests are created. All of our repositories should have a Codeowners definition.
The profile README is displayed on our GitHub organisation profile. We use it to introduce ourselves and our projects to the community.
🖇 Learn more about organisation profile README
The license defines what others can and cannot do with open source code. Because the type of license will largely depend on the project, it’s been omitted here and should be added manually when you create one. All of our public repositories should have a carefully chosen license file.