Thank you for your interest in contributing to the Stately Studio and XState docs! We really appreciate contributors like you, and we welcome any contributions to the documentation and code base.
There are a number of ways you can contribute to XState and Stately Studio:
- 📥 Submit an issue
- 🖊️ Solve an issue or make a change
- 🛟 Respond to questions in the Help channel on Discord
Please read our code of conduct.
We have a Stately Guide to Writing Docs to give you guidance on how the docs are structured, how to use special content types, and how to write clear and useful docs!
Pull requests are encouraged. If you want to add documentation or fix a bug:
- Fork and clone the repository.
- Create a separate branch for your changes.
- Make your changes, and ensure that it is formatted by Prettier.
- Run
yarn buildand ensure no links are broken. - Push your branch and open a PR 🚀
PRs are reviewed promptly and merged in within a week or two (or even within one day), if everything looks good.
Issues and bug reports are also encouraged. If you want to submit an issue:
- Search existing issues to check if your issue already exists or has been solved.
- Create a new issue if your issue has not yet been submitted.
- Ensure you fill out all the details in the issue template to help us understand the issue.
We’ll try to respond promptly and address your issue as soon as possible.
Please post Stately Studio feature requests to feedback.stately.ai. There, you can:
- 🔎 Search for existing feature requests,
- ➕ Add new feature requests
- 💬 Provide feedback
- 🆕 Check out our changelog
- 🗺️ View the public roadmap
- 🗳️ Vote on proposed features, and more!