From 2a7631125099a7dd2f62ed3a692fc0eb72211c95 Mon Sep 17 00:00:00 2001 From: Jeremy Meiss Date: Sun, 19 May 2019 13:32:49 -0700 Subject: [PATCH] Updated contributor guide --- website/content/docs/contributor-guide.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/website/content/docs/contributor-guide.md b/website/content/docs/contributor-guide.md index e459141a177a..06208cae03c7 100644 --- a/website/content/docs/contributor-guide.md +++ b/website/content/docs/contributor-guide.md @@ -17,7 +17,21 @@ The GitHub website allows you to submit issues, work with files, search for cont ## Style guidelines A [style guide](/website/content/docs/style-guide.md) is available to help provide context around grammar, code styling, syntax, etc. -## Places to get involved +## Filing issues +If you have a GitHub account, you can file an [issue](https://github.com/netlify/netlify-cms/issues) (aka bug report) against the Netlify CMS docs. Even if you're not able to, or don't know how to, fix the issue (see [Improve existing content](#improve-existing-content)), it helps to start the conversation. When you file an issue, it's important to include the following info: + +- Link to page +- What is wrong +- What could/should be done + +[TODO: Update this with the information preferred/required by the Netlify CMS team] + +When filing an issue, it is important to remember the [Code of Conduct](https://github.com/netlify/netlify-cms/blob/master/CODE_OF_CONDUCT.md). + +## Improve existing content +If you are able to offer up a change to existing content, we welcome this. Once you've forked the repo, and changed the content, you would file a pull request (PR). The repo [Contributing file](https://github.com/netlify/netlify-cms/blob/master/CONTRIBUTING.md) lays out the correct format for PRs. + +## Other places to get involved While we work on building this page (and you can help!), here are some links with more information about getting involved: * [Setup instructions and Contribution Guidelines](https://github.com/netlify/netlify-cms/blob/master/CONTRIBUTING.md)