From b2b8b15a538c82230d40e2de246c27527349d4c3 Mon Sep 17 00:00:00 2001 From: Ikeme Victor <66833101+CloudIkeme@users.noreply.github.com> Date: Wed, 9 Aug 2023 06:11:32 +0100 Subject: [PATCH 1/9] fixed USE THIS TEMPLATE, Wrote and optimized the File with new sections Signed-off-by: Ikeme Victor <66833101+CloudIkeme@users.noreply.github.com> --- README copy.md | 37 +++++++++++++++++++ README.md | 97 +++++++++++++++++++++++++++++++++++++------------- 2 files changed, 110 insertions(+), 24 deletions(-) create mode 100644 README copy.md diff --git a/README copy.md b/README copy.md new file mode 100644 index 0000000..4a08cbe --- /dev/null +++ b/README copy.md @@ -0,0 +1,37 @@ +# 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 + +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..61c988a 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 repository serves as a [project template][template-repo] created by [CNCF SIG Contributor +Strategy][contrib-strat] that new open source projects can use when joining the Cloud Native Computing Foundation (CNCF). The template provides a standardized structure and initial files to help projects quickly set up a repository that follows community best practices. By forking and customizing this template, new CNCF projects can avoid reinventing the wheel and instead focus on their unique goals and needs. Overall, the template makes it easier for projects to get started under the CNCF with recommended guidelines and resources already in place.. It contains template files and best practices to help projects quickly adopt processes that align with CNCF standards. - ![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 +## 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** 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. First, 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: + +- [LICENSE](LICENSE) - Apache 2.0 by default +- [CONTRIBUTING](CONTRIBUTING.md) - Contribution guidelines +- [README](README-template.md) - Project overview and help +- [GOVERNANCE](GOVERNANCE.md) - Project leadership and governance +- [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) - Community code of conduct +- [CONTRIBUTOR_LADDER](CONTRIBUTOR_LADDER.md) +- [+-DESIGN-PROPOSALS.md DESIGN-PROPOSALS.md +- GOVERNANCE-elections.md GOVERNANCE-elections.md +- GOVERNANCE-maintainer.md GOVERNANCE-maintainer.md +- GOVERNANCE-subprojects.md GOVERNANCE-subprojects.md +- GOVERNANCE.md GOVERNANCE.md +- MAINTAINERS.md MAINTAINERS.md +- REVIEWING.md REVIEWING.md +- [.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 help you: + +Adopt the templates for your project +Understand what each template contains +Make customizations for your specific 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. +as a template for your project README. \ No newline at end of file From 02521be753e65a1bd097dfc7b6723682d109338f Mon Sep 17 00:00:00 2001 From: Ikeme Victor <66833101+CloudIkeme@users.noreply.github.com> Date: Wed, 9 Aug 2023 06:46:42 +0100 Subject: [PATCH 2/9] Fixed the 'Use This template' button to point to 'the first step needed to start customizing, added a getting started sectio, turned Customizing the template into a section and optimized it better for first timers, added a contents section listing all available templates, took the 'Security templates Notice from the website How-to and added it , so everyone is aware security templates werent left out, finally added a getting help section that points to the How-To Guides on the website. Signed-off-by: Ikeme Victor <66833101+CloudIkeme@users.noreply.github.com> --- README copy.md | 2 +- README.md | 39 ++++++++++++++++++++++++++++++--------- 2 files changed, 31 insertions(+), 10 deletions(-) diff --git a/README copy.md b/README copy.md index 4a08cbe..3e57500 100644 --- a/README copy.md +++ b/README copy.md @@ -1,6 +1,6 @@ # CNCF Project Template Repository -This is a [template repository][template-repo] for CNCF projects created by [CNCF SIG Contributor +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. diff --git a/README.md b/README.md index 61c988a..6002dae 100644 --- a/README.md +++ b/README.md @@ -52,15 +52,37 @@ This project contains templates for: - [GOVERNANCE](GOVERNANCE.md) - Project leadership and governance - [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) - Community code of conduct - [CONTRIBUTOR_LADDER](CONTRIBUTOR_LADDER.md) -- [+-DESIGN-PROPOSALS.md DESIGN-PROPOSALS.md -- GOVERNANCE-elections.md GOVERNANCE-elections.md -- GOVERNANCE-maintainer.md GOVERNANCE-maintainer.md -- GOVERNANCE-subprojects.md GOVERNANCE-subprojects.md -- GOVERNANCE.md GOVERNANCE.md -- MAINTAINERS.md MAINTAINERS.md -- REVIEWING.md REVIEWING.md +- [DESIGN-PROPOSALS](DESIGN-PROPOSALS.md) +- [GOVERNANCE-elections](GOVERNANCE-elections.md) +- [GOVERNANCE-maintainer](GOVERNANCE-maintainer.md) +- [GOVERNANCE-subprojects](GOVERNANCE-subprojects.md) +- [GOVERNANCE](GOVERNANCE.md) +- [MAINTAINERS](MAINTAINERS.md) +- [REVIEWING](REVIEWING.md) - [.github/](.github/) - GitHub community health files + +Here is that list formatted in Markdown: + +**Key Templates to Customize:** + + +- [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 like ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE etc. + +In Markdown, each list item starts with a hyphen `- ` on its own line. Let me know if you need any clarification on Markdown syntax! + 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 @@ -82,5 +104,4 @@ Review the [How-To Guides](https://contribute.cncf.io/maintainers/templates/#how [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. \ No newline at end of file +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 From 039abf35bd4d2316bef840f27f2051f87524f929 Mon Sep 17 00:00:00 2001 From: Ikeme Victor <66833101+CloudIkeme@users.noreply.github.com> Date: Wed, 9 Aug 2023 06:52:04 +0100 Subject: [PATCH 3/9] fixed green button to go to first step when clicked, added new sections like getting help which references the HOW-TO guides, content, customizing the templates, e.t.c Signed-off-by: Ikeme Victor <66833101+CloudIkeme@users.noreply.github.com> --- README.md | 34 ++++++---------------------------- 1 file changed, 6 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 6002dae..71dfe3f 100644 --- a/README.md +++ b/README.md @@ -46,42 +46,20 @@ To create a new project repository from this CNCF template: This project contains templates for: -- [LICENSE](LICENSE) - Apache 2.0 by default -- [CONTRIBUTING](CONTRIBUTING.md) - Contribution guidelines -- [README](README-template.md) - Project overview and help -- [GOVERNANCE](GOVERNANCE.md) - Project leadership and governance -- [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) - Community code of conduct -- [CONTRIBUTOR_LADDER](CONTRIBUTOR_LADDER.md) -- [DESIGN-PROPOSALS](DESIGN-PROPOSALS.md) -- [GOVERNANCE-elections](GOVERNANCE-elections.md) -- [GOVERNANCE-maintainer](GOVERNANCE-maintainer.md) -- [GOVERNANCE-subprojects](GOVERNANCE-subprojects.md) -- [GOVERNANCE](GOVERNANCE.md) -- [MAINTAINERS](MAINTAINERS.md) -- [REVIEWING](REVIEWING.md) -- [.github/](.github/) - GitHub community health files - - -Here is that list formatted in Markdown: - -**Key Templates to Customize:** - - - [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 +- [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-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 like ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE etc. +- [.github/](.github/) - GitHub community health files -In Markdown, each list item starts with a hyphen `- ` on its own line. Let me know if you need any clarification on Markdown syntax! 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) @@ -94,12 +72,12 @@ Check out the [How-To Guides](https://contribute.cncf.io/maintainers/templates/# The guides provide step-by-step instructions to help you: Adopt the templates for your project -Understand what each template contains -Make customizations for your specific 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. +Understand what each template contains +Make customizations for your specific 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 From de13bbd5704f74a983e91af33ec6035ea73e4373 Mon Sep 17 00:00:00 2001 From: Ikeme Victor <66833101+CloudIkeme@users.noreply.github.com> Date: Wed, 9 Aug 2023 07:03:49 +0100 Subject: [PATCH 4/9] fixed green button to go to first step when clicked, added new sections like getting help which references the HOW-TO guides, content, customizing the templates, e.t.c Signed-off-by: Ikeme Victor <66833101+CloudIkeme@users.noreply.github.com> --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 71dfe3f..d8d908e 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,10 @@ # CNCF Project Template -This repository serves as a [project template][template-repo] created by [CNCF SIG Contributor -Strategy][contrib-strat] that new open source projects can use when joining the Cloud Native Computing Foundation (CNCF). The template provides a standardized structure and initial files to help projects quickly set up a repository that follows community best practices. By forking and customizing this template, new CNCF projects can avoid reinventing the wheel and instead focus on their unique goals and needs. Overall, the template makes it easier for projects to get started under the CNCF with recommended guidelines and resources already in place.. It contains template files and best practices to help projects quickly adopt processes that align with CNCF standards. +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. +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. ## Getting Started @@ -16,7 +17,7 @@ To create a new project repository from this CNCF template: 2. Remove `.github/settings.yml` - this contains configuration specific to for our repo only. You should not keep this file. -3. First, Customize every [required template](#required-templates) files and those specific to your project.. +3. First, Customize every [required template](#required-templates) files and those specific to your project. 4. Remove any templates not needed. @@ -46,7 +47,7 @@ To create a new project repository from this CNCF template: This project contains templates for: -- [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) - Standards for community interaction and behavior +- [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 From daf20e3224977411f31a6df9c3760f3a66148135 Mon Sep 17 00:00:00 2001 From: Ikeme Victor <66833101+CloudIkeme@users.noreply.github.com> Date: Wed, 9 Aug 2023 07:05:29 +0100 Subject: [PATCH 5/9] fixed green button to go to first step when clicked, added new sections like getting help which references the HOW-TO guides, content, customizing the templates, e.t.c Signed-off-by: Ikeme Victor <66833101+CloudIkeme@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d8d908e..80dc6bb 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ By creating a copy and customizing the template, projects can focus on their uni To create a new project repository from this CNCF template: -1. Click **Use this template** and create a copy of this repository under your own organization. +1. Click **'Use this template'** below and create a copy of this repository under your own organization. [![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) From 64b2609ad26e528ccaf7afe8006c9956f3df41a5 Mon Sep 17 00:00:00 2001 From: Ikeme Victor <66833101+CloudIkeme@users.noreply.github.com> Date: Wed, 9 Aug 2023 07:07:23 +0100 Subject: [PATCH 6/9] fixed green button to go to first step when clicked, added new sections like getting help which references the HOW-TO guides, content, customizing the templates, e.t.c Signed-off-by: Ikeme Victor <66833101+CloudIkeme@users.noreply.github.com> --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 80dc6bb..048f002 100644 --- a/README.md +++ b/README.md @@ -73,9 +73,7 @@ Check out the [How-To Guides](https://contribute.cncf.io/maintainers/templates/# The guides provide step-by-step instructions to help you: Adopt the templates for your project - Understand what each template contains - Make customizations for your specific 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. From 3af9a9da27b2a010ca73df2bbc0b58d516600229 Mon Sep 17 00:00:00 2001 From: Ikeme Victor <66833101+CloudIkeme@users.noreply.github.com> Date: Wed, 9 Aug 2023 07:12:15 +0100 Subject: [PATCH 7/9] fixed green button to go to first step when clicked, added new sections like getting help which references the HOW-TO guides, content, customizing the templates, e.t.c Signed-off-by: Ikeme Victor <66833101+CloudIkeme@users.noreply.github.com> --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 048f002..941601e 100644 --- a/README.md +++ b/README.md @@ -70,12 +70,11 @@ Need guidance on using these templates? Want to learn more about customizing a s 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 help you: - -Adopt the templates for your project -Understand what each template contains -Make customizations for your specific needs +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 From 4294b5ec15e3bf08555d3185aa1e0eeb3e8dbe46 Mon Sep 17 00:00:00 2001 From: Ikeme Victor <66833101+CloudIkeme@users.noreply.github.com> Date: Wed, 9 Aug 2023 07:13:56 +0100 Subject: [PATCH 8/9] fixed green button to go to first step when clicked, added new sections like getting help which references the HOW-TO guides, content, customizing the templates, e.t.c Signed-off-by: Ikeme Victor <66833101+CloudIkeme@users.noreply.github.com> --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 941601e..85e27ea 100644 --- a/README.md +++ b/README.md @@ -75,9 +75,12 @@ 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. \ No newline at end of file From 928263a4b35d72517ec754cae9f346006415cc14 Mon Sep 17 00:00:00 2001 From: Ikeme Victor <66833101+CloudIkeme@users.noreply.github.com> Date: Wed, 9 Aug 2023 07:27:45 +0100 Subject: [PATCH 9/9] fixed green button to go to first step when clicked, added new sections like getting help which references the HOW-TO guides, content, customizing the templates, e.t.c Signed-off-by: Ikeme Victor <66833101+CloudIkeme@users.noreply.github.com> --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 85e27ea..2d2fed2 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ To create a new project repository from this CNCF template: 2. Remove `.github/settings.yml` - this contains configuration specific to for our repo only. You should not keep this file. -3. First, Customize every [required template](#required-templates) files and those specific to your project. +3. Customize every [required template](#required-templates) files and those specific to your project. 4. Remove any templates not needed. @@ -66,7 +66,8 @@ Please note that the security templates may be found in the [Security TAG’s pr ## Getting Help -Need guidance on using these templates? Want to learn more about customizing a specific template? +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. @@ -82,5 +83,4 @@ Review the [How-To Guides](https://contribute.cncf.io/maintainers/templates/#how [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. \ No newline at end of file