Templates

We have a project template repository that has templates for everything your project needs to get started and eventually join the CNCF.

Getting Started

The templates are stored in the project template repo, but we also have how-to guides here on the website that are a better place to start if you haven’t used a particular template before.

Please note that the security templates may be found in the Security TAG’s project resources folder.

Customize Templates

Each template contains 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.

How-To Guides

• HowTo: Make a Contributing Guide
• Using the Governance Templates
  • The Steering Committee Elections Template
  • The Maintainer Council Template
  • The Governance By Subprojects Template
• Maintainer List Template
• HowTo: Make a Reviewing Guide
• Issue Labels for New Contributors

Available Templates

• CODE_OF_CONDUCT.md
• CONTRIBUTING.md
• LICENSE
• Governance
  • CONTRIBUTOR_LADDER.md
  • GOVERNANCE-elections.md
  • GOVERNANCE-maintainer.md
  • GOVERNANCE-subprojects.md
  • MAINTAINERS.md
• Security
  • ISSUE_TEMPLATE.md
  • SECURITY.md
  • SECURITY_CONTACTS.md
  • embargo-policy.md
  • embargo.md
  • incident-response.md
• README.md
• REVIEWING.md