Skip to content

Latest commit

 

History

History
25 lines (20 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

25 lines (20 loc) · 1.11 KB
Raw

Contributing

First of all, thank you for showing interest in contributing to the library, all your contributions are extremely valuable to the project!

Contribution workflow

  • Decide what you want to work on, and open a GitHub discussion to discuss them with the maintainers.
  • Fork the repository and clone it locally.
  • Create a new branch from the main branch.
  • Add your code and tests.
  • Run npm test to make sure all tests are passing.
  • Push your branch to your fork.
  • Open a pull request to the main branch and describe what you have done and why you did it.
  • Wait for the maintainers to review your pull request.
  • Make changes if requested.
  • Once your pull request is approved, it will be merged into the main branch and will be included in the next release.
  • Your PR is merged! 🎉 You are awesome!

Get started with the project locally

  1. Clone or download the repository.
  2. Install dependencies: yarn (other package managers are not supported).
  3. Run npm test to make sure everything is working as expected.
  4. Write your code in src/ directory.
  5. To run Jest tests, use npm run jest.