Adonis is an ever-expanding, frequently updated, slightly complicated, system. To keep Adonis functional and somewhat readable rather than a tangled mess, here are some guidelines in the form of an FAQ to consider before submitting a pull request:
A: @Sceleratis, as well as our community maintainers (viz. @Coasterteam, @joritochip, @Expertcoderz) and @Dimenpsyonal are responsible for the final approval and merging of PRs, and the publishing of releases from time to time.
Anyone in the community may submit code reviews for PRs and make discussions on the PR's page (or in the Discord server).
Maintainers may manage PR labels or edit PR titles and descriptions where beneficial to conform to the standards described below.
A: Title: The title of a PR should be in the present tense, and equivalent to a concise statement describing what was added, changed or removed by the PR: "Add XXX setting"; "Add :somenewcommand"; "Fix for :somecommand not doing XXX"; "Fix for :somecommand to account for XXX"; ":somecommand now does XXX"; "Add confirmation prompt for :somecommand"9
A short explanation/clarification may be appended to the title, and should be included if the PR involves making a change with a rationale that users may not understand: "Add confirmation prompt for :somecommand to prevent XXX"
Note that Adonis commands are always referenced by their prefix and common usage name (":somecommand"/":somecmd"), and not anything else including their internal index ("SomeCommand"). This is to ensure consistency and easy comprehension by normal Adonis users.
Description: The description of a PR should be comprehensive and either describe, or list and describe the specific additions, changes, and/or removals made by the PR, and their full rationale.
Proof of functionality: A PR must contain some form of you showcasing your PR working inside Roblox. This is to ensure that no breaking PRs are merged and to maintain a high quality of Pull Request. This can be a video or some other form of media which adequately displays that your PR is functional. Exceptions will be made for small PRs that are obviously functional such as fixing typos, tweaking minor functionality, etc.
ℹ️ The above rules do not apply to individual commit names and descriptions.
You may optionally include relevant label(s) in your PR to classify it. (Maintainers will add the labels otherwise after reviewing your PR.)
A: Anything within reason! Contributions can be to Adonis itself or the wiki (or both!) As long as your addition or change is useful and doesn't break something, and makes sense (while not violating Roblox's rules) it will probably be merged. However, something may occasionally be deemed unnecessary or incomplete, at which point a comment will be made on the PR for you to respond to or amend your code (or just so you know the maintainers' reasoning.)
A: Anything that violates Roblox's rules (as in, anything that could get Adonis or games using Adonis in trouble) is not allowed for obvious reasons. Additionally, please do not submit any form of obfuscated code as they have no place in the open-source project that Adonis is.
There is a very clear/obvious difference between unavoidably complex code and intentionally complicated code. Maintainers are certain to check all file changes before merging and can usually spot something abnormal quickly.
A: Not really, but we would normally try to follow the format of the other existing code in the module we are editing, as well as the Roblox Lua Style Guide where applicable. Also, be sure to use US English spellings for both code variable names and user-facing text.
A: Bugs! 🐛 If you are submitting code changes, please be sure to TEST THEM BEFORE SUBMITTING THEM! No one would be quite happy to spend an hour debugging your contribution when merging changes into the model.
Also, try to double-check any text for spelling issues. Some of us frequently make typos/mistakes, so it's not a huge deal if you miss something, but a wholly incoherent string of letters and words is not acceptable.
Finally, be sure to make file changes based on the latest version of the master branch, not release! Outdated and conflicting code is often a pain to deal with.
A: Please check for Rojo Documentation for full details, but in short, you'll need to install the Rojo CLI if you don't already have it. If you don't have the Aftman toolchain manager, install it. Then, inside the Adonis folder, run aftman install. Finally, run rojo plugin install to add the plugin to your studio.
Please note, that if you have installed a plugin from the Roblox Plugin Marketplace created by LPGhatguy, it will not work correctly and has been deprecated, DO NOT use this plugin, it WILL cause side effects, such as UI font size issues. Alternatively, if you prefer, you may also download the plugin from the Creator Marketplace, but do note your version may get out of sync without warning.
After installing Rojo, you can serve it by running rojo serve or by using the optional VSCode plugin. Then, connect thru the Rojo Plugin in Studio and accept the changes.
A: Wiki contributions should focus on technical information, such as what various functions and variables do/are for and how to use them correctly when developing plugins for Adonis. Information about Adonis and useful tutorials for new or inexperienced users is also acceptable (and much welcomed.) To add wiki contributions, message a maintainer with information regarding your requested fix and it will be reviewed.
A: After handling the merge, a maintainer will also add you to the credits list as "@GitHub YourGitHubUsernameHere" if it's your first contribution. If we forget to do this, and you notice, just us me know (via Discord or comment on the PR itself) and we'll fix it.
Once in a while after changes are merged, some quick testing will be done by a maintainer to make sure everything works correctly. Once that's done, the updated models will be published to Roblox by an automated process, after which all new servers will be running the latest version of Adonis.
A: After your contribution is accepted, post your Discord & Roblox usernames into the discussion thread (Epix-Incorporated#433). You will be given the "GitHub Contributor" role in the Discord server and the "Contributors" rank in the Roblox group (Epix Incorporated) by a maintainer, assuming you are a member of the server and group respectively.
Roblox group: https://www.roblox.com/groups/886423
Discord server: https://discord.com/invite/H5RvTP3
Feel free to make enquiries on our Discord server.
Adonis Contribution Guide 2024