Contributing

(fix): Describe the issue and include steps to reproduce, include the earliest version that you know has the issue
(feat)ure: Describe the desired behavior and include any possible solutions
(doc)ument: Describe which component lacks documentation, not all document changes may require a ticket
(test): Describe which component lacks test coverage
(tech): Describe what part of the code infrastructure should change

Building things is fun! Feel free to submit issues, suggest features, and even submit pull requests!

Getting Started

To contribute to the code base we need some sort of ticket to help communicate the desired changes.

Once we have a ticket to work off of making changes is a breeze.

Fork the repository
Create a topic branch
- Please avoid working directly on the master branch
- git checkout -b fix/my-fix-name master
Make commits of logical units
Make sure your commit messages are in the following format

  ({topic}) {subject}

  {description}

Example:

  (fix:#23) add missing bus control

  No bus control was provided in the original implementation.
  All future components should have a bus control.

Make sure you have added the necessary tests for your changes
Run all the tests to make sure nothing else was accidentally broken
Submit a pull request to the master branch
Once submitted, feedback will be provided and additional changes may have to be made before we can merge it into master