Giter Club home page Giter Club logo

project-template's Introduction

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.

project-template's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.