Skip to content

Contributing to Roblo3

Submitting Bug Reports and Feature Requests

Before submitting a bug report, remember to check via the AWS Management Console (the AWS CLI or official SDKs may also work) that your access keys/IAM User have access the resource you're attempting to use, and that the resource you're attempting to access has been configured properly and as you expected.

Additionally, remember that the Roblo3 SDK function's cannot be tested in regular Studio test mode, as you will receive InvalidSignatureExceptions unless you set your computer timezone to Universal Coordinated Time (aka UTC; this is also normally the same as Greenwich Mean Time), or you are in a timezone aligned with Universal Coordinated Time.

If you've done all the above steps and your bug persists, then submit an issue describing your bug and steps to reproduce it (ideally with code samples; AWS security credentials removed, of course).

If you'd like to submit a feature request, simply describe the feature you'd like added and some sample use cases. Note that the SDK only handles signing, transmitting, receiving, parsing, and translating requests and responses from AWS; extraneous functions that are not offered by the AWS APIs are limited to only those that are critical in the five aforementioned actions for handling requests to AWS and responses from AWS.

Building the Model from 'Scratch'

  1. To build the model from scratch, ensure the latest version of Rojo in installed on both your computer and Roblox Studio. (Rojo Version 6 was used to build the model, however version 0.5 should also work.)
  2. Clone the repository to your computer and open Roblox Studio.
  3. Open the cloned repository to its root directory, then run rojo serve and connect the Rojo plugin. The SDK should appear in ServerScriptService.

Contributing to the Project

If you'd like to contribute to the project, simply fork the repository, edit/add to the codebase, and submit a pull request. As best as possible, your code will be reviewed for security vulnerabilities and functionality of any resources that were changed. Assuming your code passes both of these tests and a merge conflict does not occur, your pull request will likely be merged.

If you are a trusted member and have contributed to the project greatly, you may be invited to receive write access to the repository.

Last update: 2020-07-18