Contributing

Contributions to the project are primarily done through modifications to the system structure, improvements to documentation wording, and evaluation of potential solutions. This includes adding, modifying, or restructuring blocks and interfaces as well as correcting spelling/grammar mistakes and writing research reports on a new design.

How Can I Contribute?

Report Bugs

To report a bug, use the .github/ISSUE_TEMPLATE/bug_report.md to create a new Bug Report issue.

Suggest Features

To suggest a feature, use the .github/ISSUE_TEMPLATE/feature_request.md to create a new Feature Request issue.

Create a Pull Request

If you want to add a few quick changes or are adding changes related to an issue,

  1. Fork the repository

  2. Make your changes

  3. Use the .github/PULL_REQUEST_TEMPLATE.md to create a pull request describing your changes

Otherwise, please use the .github/ISSUE_TEMPLATE.md to create a new Feature Request issue and include a comment requesting to be assigned to that issue.