From dfd4bf4d84412d3f9e3d37e3c3bceea0c5f26acb Mon Sep 17 00:00:00 2001 From: cjyabraham Date: Wed, 2 Mar 2022 13:10:40 +0700 Subject: [PATCH 1/4] Initial draft of the contributing guide --- CONTRIBUTING.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..646b7acc3f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,14 @@ +# CNCF Glossary contributing guide + +Thanks for your interest in contributing to the project. Contributions will be reflected on [glossary.cncf.io](https://glossary.cncf.io/) :sparkles: . + +Please read the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). + +Below are the guidelines for how to contribute to the code that runs the CNCF Glossary website. For guidlines on contributing to the content of the Glossary itself, however, please see [How to Contribute](https://glossary.cncf.io/contribute/). + +## How can I contribute? + +1. **Report a bug**. If you see a technical issue with the CNCF Glossary site or something that doesn't look right, search [the existing issues](https://github.com/cncf/glossary/issues) to see if it has been reported already. If not, please [create a new issue](https://github.com/cncf/glossary/issues/new) describing the bug. +2. **Fix a bug**. Find [an issue](https://github.com/cncf/glossary/issues) you want to fix and submit a PR for approval. + +Read [more about the code that runs the Glossary site](https://github.com/cncf/glossary/blob/main/spin-new-glossary.md) and [how to set up your own local development instance](https://github.com/cncf/glossary#setting-up-a-local-instance). To connect with our community and ask questions, please join [this slack channel](https://cloud-native.slack.com/archives/C02TX20MQBB). From d9bd078a43ddf97004ccc070210cf924f054326e Mon Sep 17 00:00:00 2001 From: cjyabraham Date: Wed, 2 Mar 2022 13:15:15 +0700 Subject: [PATCH 2/4] a few tweaks --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 646b7acc3f..cc93946d74 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # CNCF Glossary contributing guide -Thanks for your interest in contributing to the project. Contributions will be reflected on [glossary.cncf.io](https://glossary.cncf.io/) :sparkles: . +Thanks for your interest in contributing to the project. Contributions will be reflected on [glossary.cncf.io](https://glossary.cncf.io/) :sparkles: Please read the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). @@ -11,4 +11,4 @@ Below are the guidelines for how to contribute to the code that runs the CNCF Gl 1. **Report a bug**. If you see a technical issue with the CNCF Glossary site or something that doesn't look right, search [the existing issues](https://github.com/cncf/glossary/issues) to see if it has been reported already. If not, please [create a new issue](https://github.com/cncf/glossary/issues/new) describing the bug. 2. **Fix a bug**. Find [an issue](https://github.com/cncf/glossary/issues) you want to fix and submit a PR for approval. -Read [more about the code that runs the Glossary site](https://github.com/cncf/glossary/blob/main/spin-new-glossary.md) and [how to set up your own local development instance](https://github.com/cncf/glossary#setting-up-a-local-instance). To connect with our community and ask questions, please join [this slack channel](https://cloud-native.slack.com/archives/C02TX20MQBB). +Read [more about the code that runs the Glossary site](https://github.com/cncf/glossary/blob/main/spin-new-glossary.md) and [how to set up your own local development instance](https://github.com/cncf/glossary#setting-up-a-local-instance). To connect with our community and ask questions, please join [the #glossary channel on the CNCF slack](https://cloud-native.slack.com/archives/C02TX20MQBB). From b9e5dcea9b1da99a7c014b1bb42c133b6db22e8f Mon Sep 17 00:00:00 2001 From: cjyabraham Date: Wed, 2 Mar 2022 13:16:42 +0700 Subject: [PATCH 3/4] typo --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cc93946d74..3cd74f9c9d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Thanks for your interest in contributing to the project. Contributions will be r Please read the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). -Below are the guidelines for how to contribute to the code that runs the CNCF Glossary website. For guidlines on contributing to the content of the Glossary itself, however, please see [How to Contribute](https://glossary.cncf.io/contribute/). +Below are the guidelines for how to contribute to the code that runs the CNCF Glossary website. For guidelines on contributing to the content of the Glossary itself, however, please see [How to Contribute](https://glossary.cncf.io/contribute/). ## How can I contribute? From 5cc220dda295d298c5eaff4a9ab3beaf5ce92768 Mon Sep 17 00:00:00 2001 From: cjyabraham Date: Wed, 2 Mar 2022 13:19:02 +0700 Subject: [PATCH 4/4] tweak --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3cd74f9c9d..79714f4079 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,7 @@ Below are the guidelines for how to contribute to the code that runs the CNCF Gl ## How can I contribute? -1. **Report a bug**. If you see a technical issue with the CNCF Glossary site or something that doesn't look right, search [the existing issues](https://github.com/cncf/glossary/issues) to see if it has been reported already. If not, please [create a new issue](https://github.com/cncf/glossary/issues/new) describing the bug. +1. **Report a bug**. If you see a technical issue with the CNCF Glossary site or something that doesn't look right, search [the existing issues](https://github.com/cncf/glossary/issues) to see if it has been reported already. If not, please [create a new issue](https://github.com/cncf/glossary/issues/new) describing the bug. Please provide all steps necessary to reproduce the bug and screenshots if applicable. 2. **Fix a bug**. Find [an issue](https://github.com/cncf/glossary/issues) you want to fix and submit a PR for approval. Read [more about the code that runs the Glossary site](https://github.com/cncf/glossary/blob/main/spin-new-glossary.md) and [how to set up your own local development instance](https://github.com/cncf/glossary#setting-up-a-local-instance). To connect with our community and ask questions, please join [the #glossary channel on the CNCF slack](https://cloud-native.slack.com/archives/C02TX20MQBB).