Skip to content

Latest commit

 

History

History
21 lines (15 loc) · 1.32 KB

CONTRIBUTING.md

File metadata and controls

21 lines (15 loc) · 1.32 KB
Raw

Contributing

Thank you for your interest in contributing to xstate-tree! This project is made possible by contributors like you, and we welcome any contributions to the code base and the documentation.

Environment

  • Ensure you have the latest version of Node and NPM.
  • Run npm install to install all needed dev dependencies.

Making Changes

Pull requests are encouraged. If you want to add a feature or fix a bug:

  1. Fork and clone the repository
  2. Create a separate branch for your changes
  3. Make your changes, and ensure that it is formatted by Prettier and type-checks without errors in TypeScript
  4. Write tests that validate your change and/or fix.
  5. Run npm run build and then run tests with npm run test
  6. Run api-extractor and update xstate-tree.api.md if it says the document has changed.
  7. Commit your changes following conventional commit format, use git cz to help you with this.
  8. Push your branch and open a PR 🚀