README.md
is a generated file. Do not edit it directly. Edit the files inside .README
instead.
When making a commit, the following Pre-Commit hooks run:
All commit messages must begin with one of the following prefixes:
fix:
feat:
refactor:
docs:
chore:
The prefix is used to bump the correct segment of the version number during the automatic release.
Run them with npm test
.
Run with npm run lint
.
Just before submitting a PR, run npm run create-readme
to generate the new README.md
tests/rules/assertions
named the camelCase
version of your rule name with the following template:export default { invalid: [], valid: [] }
tests/rules/index.js
src/rules
named the camelCase
version of your rule namesrc/index.js
./.README/rules/[rule-name].md
.<!-- assertions spaceAfterTypeColon -->
declaration.A CI service will build and publish the new documentation.
Note: Sections “The following patterns are considered problems:” and “The following patterns are not considered problems:” are generated automatically using the test cases.