redoc/.github/styles/Rules/HeaderGerunds.yml

8 lines
260 B
YAML
Raw Permalink Normal View History

extends: existence
message: 'Do not start headings with with a gerund (ing word). Use an imperative verb instead.'
link: https://intranet.redoc.ly/contributing/documentation-style-guide/#content-organization
level: error
scope: heading
tokens:
- '^\w*ing.*'