Skip to content

Latest commit

 

History

History
20 lines (14 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

20 lines (14 loc) · 1.2 KB
Raw

Contributing

Thank you for your interest in contributing to XState Marionettist! 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 necessary dev dependencies.
  • Run npm test check if everything is working as expected.

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. Implement new features in the example end-to-end test if applicable.
  5. Run tests with npm test
  6. Push your branch and open a PR 🚀