CNCF Project Template Repository

This is a template repository for CNCF projects created by CNCF SIG Contributor Strategy. You can use it to either start a new repository that has all the required files for a CNCF project or just grab the particular files that you need.

Steps

1. Click Use this template and create a copy of this repository.

   

2. Remove .github/settings.yml. This is not a template and contains configuration specific our repository. You should not keep this file.

3. Customize every required template and address each TODO item.

Customize Templates

Each file is a template with instructions to customize the contents for your project. Most files use comments with TODO to call out where you need to make changes. We recommend viewing the files in raw or text form so that you can see the comments.

For example in markdown files, we use <!-- TODO: ... --> to provide additional guidance or indicate where action is required but you won't see those comments when you view the markdown file in GitHub unless you view the raw text.

Templates

Required

These files are required for all CNCF projects. The TOC checks for these during due diligence.

• LICENSE - Apache 2.0 or CNCF-approved license
• README-template.md - Project README (rename to README.md)
• CONTRIBUTING.md - How to contribute
• CODE_OF_CONDUCT.md - CNCF Code of Conduct
• MAINTAINERS.md - Current maintainers with affiliations
• GOVERNANCE.md - Choose a governance model:
  • GOVERNANCE-maintainer.md - Maintainer council
  • GOVERNANCE-elections.md - Elected steering committee
  • GOVERNANCE-subprojects.md - Federated subprojects
• SECURITY.md - Vulnerability reporting process

Recommended

These files are recommended and become increasingly important at incubation and graduation.

• ADOPTERS.md - Production adopters list (required for moving levels)
• CONTRIBUTOR_LADDER.md - Contributor roles and progression
• RELEASES.md - Release process (required at incubation, detailed at graduation)
• REVIEWING.md - Code review guidelines
• DESIGN-PROPOSALS.md - Design proposal process
• CODEOWNERS - Code ownership mapping (should match GOVERNANCE.md)
• .github/ISSUE_TEMPLATE/ - Bug report and feature request templates
• .github/PULL_REQUEST_TEMPLATE.md - PR checklist

Note: This is the README file for the templates repo. Please use README-template.md as a template for your project README.