diff --git a/README copy.md b/README copy.md new file mode 100644 index 0000000..3e57500 --- /dev/null +++ b/README copy.md @@ -0,0 +1,37 @@ +# CNCF Project Template Repository + +This is a [template repository][] for CNCF projects created by [CNCF SIG Contributor +Strategy][contrib-strat]. 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"](https://user-images.githubusercontent.com/1368985/95903529-e9c32f00-0d5b-11eb-8723-4369f7c9e044.png) +1. Remove **.github/settings.yml**. This is not a template and contains + configuration specific our repository. You should not keep this file. +1. Customize every [required template](#required-templates) 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 `` 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 + +* [LICENSE](LICENSE) +* [CONTRIBUTING.md](CONTRIBUTING.md) +* [README-template.md](README-template.md) + +[template-repo]: https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template +[contrib-strat]: https://github.com/cncf/sig-contributor-strategy/blob/master/README.md + +Note: This is the README file for the templates repo. Please use [README-template.md](README-template.md) +as a template for your project README. diff --git a/README.md b/README.md index 4a08cbe..2d2fed2 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,86 @@ -# CNCF Project Template Repository -This is a [template repository][template-repo] for CNCF projects created by [CNCF SIG Contributor -Strategy][contrib-strat]. 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 +# CNCF Project Template -1. Click **Use this template** and create a copy of this repository. +This [template repository][template-repo] by [CNCF SIG Contributor +Strategy][contrib-strat] helps new projects join CNCF. It provides a standardized structure and starter files to quickly set up a repository following community best practices. - ![Green button that says "Use this template"](https://user-images.githubusercontent.com/1368985/95903529-e9c32f00-0d5b-11eb-8723-4369f7c9e044.png) -1. Remove **.github/settings.yml**. This is not a template and contains - configuration specific our repository. You should not keep this file. -1. Customize every [required template](#required-templates) and address each TODO item. +By creating a copy and customizing the template, projects can focus on their unique goals instead of reinventing the wheel. Overall, it makes adopting CNCF guidelines and resources easier so projects can start strong. -### Customize Templates +## Getting Started -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. +To create a new project repository from this CNCF template: -For example in markdown files, we use `` 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. +1. Click **'Use this template'** below and create a copy of this repository under your own organization. -## Required Templates + [![Green button that says "Use this template"](https://user-images.githubusercontent.com/1368985/95903529-e9c32f00-0d5b-11eb-8723-4369f7c9e044.png)](https://github.com/new?template_name=project-template&template_owner=cncf) -* [LICENSE](LICENSE) -* [CONTRIBUTING.md](CONTRIBUTING.md) -* [README-template.md](README-template.md) +2. Remove `.github/settings.yml` - this contains configuration specific to for our repo only. You should not keep this file. -[template-repo]: https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template +3. Customize every [required template](#required-templates) files and those specific to your project. + +4. Remove any templates not needed. + +5. Delete this top level README and rename [README-template.md](README-template.md) to README.md. + +6. Update all references to `project`, `repo`, etc. Add links/badges specific to your project. + +## Customizing the Template + +- ### Required Templates: + + - [LICENSE](LICENSE) - Replace with your project's license + - [CONTRIBUTING](CONTRIBUTING.md) - Add project specific contribution guidelines + - [README](README-template.md) - Use as starting point for your README + +- Most files contain TODO comments with instructions on what needs to be changed. We recommend viewing the raw text or markdown source to see all the TODO comments. + +- For example, in markdown files we use this syntax: + + `` + + to provide guidance and indicate where action is required. These TODO comments will not be visible when viewing the rendered markdown on GitHub, only in the raw text. + +- Reviewing the raw files or enabling markdown rendering allows you to fully utilize the template by seeing all the customizable sections marked with TODOs. + +## Contents + +This project contains templates for: + +- [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) - Standards for community interaction and behavior +- [CONTRIBUTING](CONTRIBUTING.md) - Guidelines for contributing to the project +- [CONTRIBUTOR_LADDER](CONTRIBUTOR_LADDER.md) - Details on roles and responsibilities for contributors. +- [DESIGN-PROPOSALS](DESIGN-PROPOSALS.md) - Template for proposing and documenting major feature designs +- [GOVERNANCE](GOVERNANCE.md) - Project leadership, decision-making, and governance models +- [GOVERNANCE-elections](GOVERNANCE-elections.md) - Leadership election process +- [GOVERNANCE-maintainer](GOVERNANCE-maintainer.md) - Expectations and requirements for maintainers +- [GOVERNANCE-subprojects](GOVERNANCE-subprojects.md) - Guidelines for creating subprojects +- [LICENSE](LICENSE) - Open source license terms, Apache 2.0 by default +- [MAINTAINERS](MAINTAINERS.md) - Current project maintainers and sponsoring entities +- [README](README-template.md) - High level overview and documentation for the project +- [REVIEWING](REVIEWING.md) - Code and documentation review process +- [.github/](.github/) - GitHub community health files + + +Please note that the security templates may be found in the [Security TAG’s project resources folder.](https://github.com/cncf/tag-security/tree/main/project-resources) + +## Getting Help + +Need guidance on using these templates? +Want to learn more about customizing a specific template? + +Check out the [How-To Guides](https://contribute.cncf.io/maintainers/templates/#how-to-guides) on our website. + +The guides provide step-by-step instructions to: + +- Adopt templates +- Understand template contents +- Customize for your needs + +Review the [How-To Guides](https://contribute.cncf.io/maintainers/templates/#how-to-guides) for assistance with getting started and fully utilizing these project templates. + +[template-repo]: https://github.com/cncf/project-template [contrib-strat]: https://github.com/cncf/sig-contributor-strategy/blob/master/README.md -Note: This is the README file for the templates repo. Please use [README-template.md](README-template.md) -as a template for your project README. + +Note: This is the README file for the templates repo. Please use [README-template.md](README-template.md) as a template for your project README. \ No newline at end of file