Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 2.37 KB
Raw

Contributing

Development Process

All work on this project happens directly on GitHub. Contributors send pull requests which go through a review process.

Working on your first pull request? You can learn how from this free series: How to Contribute to an Open Source Project on GitHub.

  1. Fork the repo and create your branch from master (a guide on how to fork a repository).
  2. Run npm install to install all required dependencies.
  3. Now you are ready to make your changes!

Tests & Verifications

Currently we use eslint with prettier for linting and formatting the code. They are run on Github Actions for all opened pull requests, but you should use them locally when making changes.

  • npm run lint: Run eslint.
  • npm run lint:fix: Run eslint and automatically fix issues. This is useful for correcting code formatting.
  • npm run test: Run tests.
  • npm run test:watch: Run tests in watch mode.

Sending a pull request

When you're sending a pull request:

  • Prefer small pull requests focused on one change.
  • Verify that all tests and validations are passing.
  • Follow the pull request template when opening a pull request.

Commit message convention

We prefix our commit messages with one of the following to signify the kind of change:

  • build: Changes that affect the build system or external dependencies.
  • ci, chore: Changes to our CI configuration files and scripts.
  • docs: Documentation only changes.
  • feat: A new feature.
  • fix: A bug fix.
  • perf: A code change that improves performance.
  • refactor: A code change that neither fixes a bug nor adds a feature.
  • style: Changes that do not affect the meaning of the code.
  • test: Adding missing tests or correcting existing tests.

Release process

We use Semantic Release to automatically release new versions of the library when changes are merged into master. Using the commit message convention described above, it will detect if we need to release a patch, minor, or major version of the library.

Reporting issues

You can report issues on our bug tracker. Please search for existing issues and follow the issue template when opening an issue.