This repo contains sample files to be used in CloudZero open source software repositories. These files are guidelines that can be used in a CloudZero or any open source project to ensure that the project is described properly, the contribution process is clear, and additional tools like CI, coverage monitors, and quality checkers are configured properly.
This template is based largely on Auth0's open-source-template, thank you Auth0, we ❤️ you all, and not just because you have a zero in your company name! 🤗
This repo can be cloned, modified, then re-purposed for new open source projects. It can also be used piecemeal to improve existing repos.
The core of open source repo quality is the README.md file that's displayed on the repo's homepage in Github.
The README-sample.md included here was collaboratively created by CloudZero's engineering team and community
engineering team based on samples of high-quality README files around the web.
Most sections within this file should be considered required, even if that section contains a link to a more relevant page. Certain sections will contain repo-specific information and should be modified as needed:
- Description (below the title)
- Badges
- Documentation
- Installation
- Getting Started
- Thank you
- License
Other sections should be used as-is with minimal changes:
- Table of Contents
- Contribution
- Support + Feedback
- Vulnerability Reporting
- What is CloudZero?
The issue and PR templates contained in this repo are general guidelines for what to include. What is being asked for is entirely up to the repo maintainer but a template of some kind should be included.
See README-sample.md for guidelines.
This file contains files that will be excluded from git. Modify as needed based on the technology being used.
Additional template files have been included here for the specific technology that we work with. These should be considered as guidelines and not enforced in any way.
We appreciate feedback and contribution to this template! Before you get started, please see the following:
A big thank you to all of our sources of inspiration!
- First Contributions by @Roshanjossey
- First Timers Only
- Sane Github Labels
- Awesome README by @matiassingers
- Auth0 for pulling all this together!
... and many more!
This repo is covered under the Apache 2.0.