Skip to content

Latest commit

 

History

History
23 lines (16 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

23 lines (16 loc) · 1.55 KB
Raw

Contributing

Thank you for your interest in contributing to XState! 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 Yarn.
  • Run yarn 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 yarn build and then run tests with yarn test (for all packages) or yarn test:core (for only changes to core XState).
  6. For package changes, add docs inside the /packages/*/README.md. They will be copied on build to the corresponding /docs/packages/*/index.md file.
  7. Create a changeset by running yarn changeset. More info.
  8. Push your branch and open a PR 🚀

PRs are reviewed promptly and merged in within a day or two (or even within an hour), if everything looks good.