Skip to content

Latest commit

 

History

History
33 lines (21 loc) · 1.05 KB

CONTRIBUTING.md

File metadata and controls

33 lines (21 loc) · 1.05 KB
Raw

Contributing

Do you want to contribute? We're excited to hear that!

Requirements

Setup

  1. Clone the repo
  2. Install dependencies yarn

Boom! You are ready to go.

Commit messages

We use Conventional Commits for commit messages.

PR Guidelines

  1. Create a PR with a descriptive title and description.
  2. Add a screenshot if you are making any UI (terminal integration) changes.
  3. If you added a new feature or fixed a bug, add a test case for it.
  4. Check your code using our ESLint config yarn lint:eslint
  5. Check your code using our Prettier config yarn lint:prettier
  6. Add a link to the report if you are making any changes to the report.
  7. Add a link to the issue you are fixing.

License

By contributing you agree that your contributions will be licensed under its MIT License