Skip to content

Latest commit

 

History

History
38 lines (24 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

38 lines (24 loc) · 1.63 KB
Raw

Should Release-It


Contributing

When contributing to this repository, please first discuss the change you wish to make via issue.

Setting up a development environment

  • Install Node.js and Yarn
  • Clone or download the repo
  • yarn to install dependencies

Issues needing help

Are you out of ideas, but still wanna help? Check out the help wanted or the good first issue labels.

Code style

We have a pre-commit hook enforcing commits to follow our lint rules. The eslint config points to index.js.

  • ESLint to enforce code style and best practices on JavaScript and TypeScript files.
  • Prettier to format JSON files.

To check for lint issues on your code, run this on your terminal:

yarn lint

And to auto-fix some of them:

yarn lint-fix

Pull request

The title of your PR should follow the Conventional Commits specification, the commits messages made inside the PR are not required to follow this specification because the PR will be squashed and the PR title will be the commit message.

Your PR is automatically inspected by various tools, check their response and try to improve your code accordingly. Requests that fail to build or have wrong coding style won't be merged.