Skip to content

Latest commit

 

History

History
31 lines (22 loc) · 827 Bytes

CONTRIBUTING.md

File metadata and controls

31 lines (22 loc) · 827 Bytes

We'd love to have you assist us via contributions to this project!

Documentation

Our documentation is maintained via Moonwave.

Coding Style

Coding Style

Follow Quenty's Roblox coding styling guide found here, as well as Roblox's general stylying guide found here.

Document Organization Guidelines

Situates your code in the following order:

  1. Class / Module Luau Documentation.
  2. Services.
  3. require statement.
  4. Module requires, using strings.
  5. Constants.
  6. Class definition.
  7. Return statement.

Sample:

--[=[
	@class MyClass
]=]

local Signal: { [any]: any } = require(game:GetService("ReplicatedStorage"):WaitForChild("Packages")["Signal"])