Contribuiting to Forest

Submitting Code

Please use make lint to ensure code is properly formatted, license headers are present, and to run the linter.

Documentation

Please use the following guidelines while documenting code. Except for inline comments, these should all be doc comments (///).

Methods/Functions

• At least a brief description

Structs

• At least a brief description

Traits

• At least a brief description

Enums

• At least a brief overall description.
• All variants should have a brief description.

Inline Comments

• Any complicated logic should include in-line comments (//)