Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contributing Guide #501

Merged
merged 4 commits into from
Mar 2, 2022
Merged

Contributing Guide #501

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dfd4bf4
Initial draft of the contributing guide
cjyabraham Mar 2, 2022
d9bd078
a few tweaks
cjyabraham Mar 2, 2022
b9e5dce
typo
cjyabraham Mar 2, 2022
5cc220d
tweak
cjyabraham Mar 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 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?

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).