Thank you for your interest in contributing to Moai! There are many ways to contribute, and we appreciate all of them:
To understand the principles that drive the design and development of Moai, see the Principles guide.
To get in touch with us, see the Get in touch section in the README. Whether you are stuck, or unsure about something, or just want to ask questions, we're more than happy to hear and help you.
If you are just getting started with contributing open source (Thank you!), we recommend GitHub's Open Source Guides and Kent C. Dodds's makeapullrequest.com to make yourself comfortable.
The recommended way to report bugs is to create an issue at Moai repo. You can also report bugs at other communication channels.
Please report bugs liberally. If you're not sure if something is a bug or not, feel free to file a bug anyway. We're more than happy to clarify them for you.
Before filing a bug, you can search existing issues, as someone else may already reported it. This is not required, and we won't mind if you accidentally file a duplicate report.
Requesting features is very much similar to reporting bugs: just create an issue to describe what do you want. You can request new components, or new features for existing components, or even a new package.
By all means, please request features liberally. Don't be afraid if it is not possible or does not make sense. We would love to discuss things like that in the issue.
We use pull requests to make changes to Moai, with the fork-and-pull model for collaboration. Basically, you fork Moai, make changes in your fork, and create a pull request back to Moai.
To test your changes, you will need to setup Moai's local development. To get started, see the DEVELOP guide.
After submitted, all pull requests are reviewed by Moai's maintainers and contributors. In fact, as a way to contribute, you are welcome to review others' PRs!
In addition to human's reviews, your PRs also run through several automated checks. These including checks for code style and some super useful preview deployments.
Documentation improvements are very welcome. We appreciate everything: a quick example, a link to clarify a term, or even typo fixes.
Moai's documentation are just code in this repository. Documentation pull requests therefore follow the same process as other pull requests.
The source of docs.moaijs.com is largely under the "lib/docs" folder. You can find all guides and examples (i.e. "Story") here. The API references (i.e. "All Props" tables) are automatically generated from the component's source code (e.g. button.ts).
To test your documentation changes, you will need to setup Moai's local development. To get started, see the DEVELOP guide.
Every contributions count, even an idea of design, documentation, or anything that is not in the source code. If you think you, or someone you know, has contributed to Moai but are not recognized yet, you can request for that contribution by asking @all-contributors bot. For more details, see the Bot Usage guide.