Contributing

Bug Reports¶

To submit a bug report, open an issue with label Type: Bug or create a response at the discussion thread.
Ensure your report includes a detailed explanation of the problem with any relavent images, videos, etc (such as console errors).
Make sure to include a link to a stipped-down uncopylocked Roblox place which reproduces the bug.

Be sure to check out the documentation and resources first before asking a question.
We recommend submitting all questions and feedback to the discussion thread.
You can also open an issue with label Type: Question.

Nanoblox is free and open source; any suggestions and code contributions are greatly appreciated!
To make a suggestion, open an issue with label Type: Enhancement or create a response at the discussion thread.
Please open a suggestion before beginning a code contribution to ensure it's discussed through fully (we wouldn't want to waste your time!).
Some tools you'll find useful when working on this project:

If you find any problems in the documentation, including typos, bad grammar, misleading phrasing, or missing content, feel free to file issues and pull requests to fix them.
API documentation should be written at the top of the corresponding module under --[[ module:header. These comment blocks are automatically converted into markdown files and deployed to the site when pulled into the main branch.
To test documentation:
1. Install Material for MKDocs.
2. Visit the TopbarPlus repository.
3. Click Fork in the top right corner.
4. Clone this fork into your local repository.
5. Change directory to this clone cd TopbarPlus.
6. Swap to the development branch git checkout development.
7. Call mkdocs serve within your terminal.
8. Open your local website (it will look something like http://0.0.0.0:8000)
9. Any changes to mkdocs.yml or the files within docs will now update live to this local site.

Important

All pull requests must be made to the development branch.