Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (43 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

64 lines (43 loc) · 1.26 KB

Setup

Generate files

if you want to create a new rule, use this command.
This command use Hygen.

$ npm run gen:rule

Development new rule

Development your awesome rule! 🔧

Create log file(optional)

If you want to check AST, use this command.
log folder is created by Hygen.
This folder is already added that gitignore.
AST is outputed to log/log.json.

$ npm run gen:log
$ npm run log

test

When write your rule's test, use this command.
This command watch tests/lib/rules.

$ npm run test

commit

If you want to use git commit, use this command.
This command use Commitizen.
Commitizen's commit template is cz-conventional-changelog

$ npm run commit

development directory

If you confirm rules in lib/rules, generate development directory with npm run gen:development. And then npm run confirm.

Did you contribute to eslint-plugin-gridsome❓

Great!!
You can add contributors list with allcontributors.
Example:

npx all-contributors add tyankatsu0105 code,doc,maintenance,test

Then, send PR.

Also check this.