Contents

# Check Title (`<%= class_name %>`)

_Version PLATFORMOS_CHECK_VERSION+_

A short description of what the check does.

A brief paragraph explaining why the check exists (what best practice is it enforcing, and why is it important?).

## Examples

The following examples contain code snippets that either fail or pass this check.

### &#x2717; Fail

```liquid
```

### &#x2713; Pass

```liquid
```

## Options

The following example contains the default configuration for this check:

```yaml
<%= class_name %>:
  enabled: false
  severity: suggestion
  other_option: 10_000
```

| Parameter | Description |
| --- | --- |
| enabled | Whether the check is enabled. |
| severity | The [severity](https://documentation.platformos.com/developer-guide/platformos-check/platformos-check#check-severity) of the check. |
| other_option | A description of the option. |

## Disabling this check

[ This check is safe to disable. You might want to disable this check if ... | Disabling this check isn't recommended because ... ].

[ This check is disabled by default when <condition>. ]

## Resources

- [Rule source][codesource]
- [Documentation source][docsource]

[codesource]: /<%= code_source %>
[docsource]: /<%= doc_source %>

Version data entries

23 entries across 23 versions & 1 rubygems

Version	Path
platformos-check-0.0.3	docs/checks/TEMPLATE.md.erb
platformos-check-0.0.2	docs/checks/TEMPLATE.md.erb
platformos-check-0.0.1	docs/checks/TEMPLATE.md.erb