Contributing
Thank you for investing your time in contributing to our project!
Please read our Code of Conduct to keep our community approachable and respectable.
When you contribute, you become a project contributor and both are shown on our repository, contributors graph, and your contribution activity.
GitHub Codespaces¶
We are fully integrated with GitHub Codespaces. When you create a codespace on our repository, all required extensions and dependencies are automatically installed to make contributing easier. The following will be automatically available:
- Rojo sync (If editing in Visual Studio Code from your local desktop client. Requires Visual Studio Code with the GitHub Codespaces extension)
- Rojo, Selene, and StyLua Extensions
- Wally packages
Additionally, our codespaces are preconfigured with pre-builds and dev containers.
Coding Style¶
If you plan to contribute, ensure that all code written in Lua follows the Roblox Lua Style Guide when applicable.
Also, make sure that your code is properly styled and linted using Selene and StyLua.
Pull Requests¶
We actively welcome your pull requests. When you submit a pull request, we will review your code and respond as soon as possible. We may suggest changes, improvements, or alternatives.
License¶
By contributing, you agree that your contributions will be licensed under the Mozilla Public License 2.0.