diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6895405c20..42d076d7df 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,13 +22,12 @@ Please read [our code of conduct](https://github.com/statelyai/xstate/blob/main/ Pull requests are encouraged. If you want to add a feature or fix a bug: 1. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) and [clone](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) the [repository](https://github.com/statelyai/xstate). -2. [Create a separate branch](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/managing-branches) for your changes. -3. Make your changes, and ensure that it is formatted by [Prettier](https://prettier.io) and type-checks without errors in [TypeScript](https://www.typescriptlang.org/). -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`. These docs will be copied on build to the corresponding `/docs/packages/*/index.md` file. -7. Create a changeset by running `yarn changeset`. [More about changesets](https://github.com/atlassian/changesets). -8. Push your branch and open a PR 🚀 +1. [Create a separate branch](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/managing-branches) for your changes. +1. Make your changes, and write tests that validate your change and/or fix. +1. Run `yarn test` (for all packages) or `yarn test:core` (for only changes to core XState). +1. Run `yarn typecheck` to make sure that there are no type errors. +1. Create a changeset by running `yarn changeset`. [More about changesets](https://github.com/atlassian/changesets). +1. 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.