Skip to content

Latest commit

 

History

History
23 lines (12 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

23 lines (12 loc) · 1.27 KB

Contributing

How to

For new features file an issue. For bugs, file an issue and optionally file a PR with a failing test.

How to develop

To execute the tests run pnpm test.

To learn about ESLint plugin development see the relevant section of the ESLint docs. You can also checkout the typescript-eslint repo which has some more information specific to TypeScript.

In order to know which AST nodes are created for a snippet of TypeScript code you can use AST explorer with options JavaScript and @typescript-eslint/parser.

Commit Messages

tl;dr: use npx cz instead of git commit.

Commit messages must follow Conventional Commit messages guidelines. You can use npx cz instead of git commit to run an interactive prompt to generate the commit message. We've customize the prompt specifically for this project. For more information see commitizen.

How to publish

Publishing is handled by semantic release - there shouldn't be any need to publish manually.