diff --git a/docs/contributing/style-guide.md b/docs/contributing/style-guide.md index b531e5894..5d2af883c 100644 --- a/docs/contributing/style-guide.md +++ b/docs/contributing/style-guide.md @@ -41,4 +41,61 @@ This includes but is not limited to the following file types: - YAML (*.yml, *.yaml) - Markdown (*.md) - JavaScript (*.js) -- TypeScript (*.ts, *.tsx) \ No newline at end of file +- TypeScript (*.ts, *.tsx) + +### Error Strings + +Error messages should follow the standard go format. This format can be found in the [golang code review comments](https://github.com/golang/go/wiki/CodeReviewComments#error-strings) +however the key points are: + +- errors should not start with capital letters (excluding proper nouns, acronyms, or initialism) +- errors should not end with punctuation +- these restrictions do not apply to logging, only the error type itself + +### Configuration Documentation + +The configuration documentation has a consistent format this section describes it as best as possible. It's recommended +to check additional sections for examples. + +#### Layout + +The first thing in the configuration documentation should be a description of the area. This is promptly followed by the +configuration heading (h2 / indent 2) which has an example full configuration. + +Under the configuration example each option in the configuration needs to be documented with its own heading +(h3 / indent 3). Immediately following the heading is a div with some stylized icons. + +The body of the section is to contain paragraphs describing the usage and information specific to that value. + + +**Example Stylized Icons:** + +```html +