Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 1.75 KB

README.md

File metadata and controls

37 lines (26 loc) · 1.75 KB
Raw

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.

    Green button that says "Use this template"

  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.

Required Templates

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