Skip to content

Latest commit

 

History

History
35 lines (23 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

35 lines (23 loc) · 1.33 KB
Raw

Contributing

Thanks for contributing!

Installation

git clone https://github.com/prettier/eslint-plugin-prettier.git
cd eslint-plugin-prettier
yarn # or `npm install`

Running the tests

npm test

This is an ESLint plugin. Documentation for the APIs that it uses can be found on ESLint's Working with Plugins page.

This plugin is used to lint itself. The style is checked when npm test is run, and the build will fail if there are any linting errors. You can use npm run lint -- --fix to fix some linting errors. To run the tests without running the linter, you can use node_modules/.bin/mocha.

Commit messages

Commit messages should start with one of the following prefixes: Breaking:, New:, Update:, Fix:, Docs:, Build:, Upgrade:, Chore:. These prefixes are automatically used to determine the release type when generating a release, as described here.

Publishing

npm run generate-release
git push --follow-tags
npm publish

npm run generate-release will autogenerate a commit, changelog entry, and git tag like https://github.com/prettier/eslint-plugin-prettier/commit/56873bf2.