Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.25 KB

CONTRIBUTION_GUIDE.md

File metadata and controls

34 lines (25 loc) · 1.25 KB
Raw

Guide to contribution

General

Issues

  • Give a short title to your issue in the title section
  • Add a tag at the beginning of your comment with the format: "[ {Tag} ] ...{comment continuation}". below are the possible tag:
    • feature request, error, bug
  • Make your comment as descriptive as possible.

Pull Request

  • PRs should follow the similar guide to issues
  • Add a tag at the beginning of your comment with the format: "[ {Tag} ] ...{comment continuation}". below are the possible tag:
    • feature request, error, bug
  • If your PR was made to fix an issue, reference the issue in your pr title like so: "{your pr title} | Issue {issue number}"

Roadmap

If you wish to contribute to the roadmap, fork this repo at branch {ROADMAP-TAG} if the branch does not exist, feel free to create one in your fork.

Code conventions

  • All variables MUST be strongly typed except in instances where it is obvious what the variable type will be by it's assigned value. see here for clarity
  • All code MUST pass static analysis.
  • DO NOT ignore any lint rule.