Skip to content

Latest commit

 

History

History
76 lines (44 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

76 lines (44 loc) · 1.99 KB
Raw

How to Contribute

We'd love to get patches from you!

Workflow

We follow the GitHub Flow Workflow

  1. Fork the project
  2. Check out the main branch
  3. Create a feature branch
  4. Write code and tests for your change
  5. From your branch, make a pull request against the main branch
  6. Work with repo maintainers to get your change reviewed
  7. Wait for your change to be pulled into main
  8. Delete your feature branch

Conventional Commits

We use conventional commits, which is enforced by commitlint, to make a commit run:

yarn cm

Testing

You can run the tests with yarn test

Style

This project uses prettier and eslint.

To check your code style you can run yarn format:check and yarn lint.

To correct issues with prettier formatting you can run yarn format.

Issues

When creating an issue please try to adhere to the following format:

module-name: One line summary of the issue (less than 72 characters)

### Expected behavior

As concisely as possible, describe the expected behavior.

### Actual behavior

As concisely as possible, describe the observed behavior.

### Steps to reproduce the behavior

List all relevant steps to reproduce the observed behavior.

Pull Requests

We adhere to the conventional commits standard for commit messages.

Code Review

Pull requests raised will be reviewed by a code owner and will be merged when all comments are resolved and the workflows complete successfully.

Documentation

We also welcome improvements to the project documentation or to the existing docs. Please file an issue.

License

By contributing your code, you agree to license your contribution under the terms of the LICENSE

Code of Conduct

Read our Code of Conduct for the project.