Skip to content

Latest commit

 

History

History
33 lines (20 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

33 lines (20 loc) · 1.33 KB

Contributing

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code.

Individual Contributor License Agreement

Before your code can be accepted into the project you must also sign the Individual Contributor License Agreement (CLA).

Bug Reports

A good bug report involves a demonstrable problem in the existing code with steps to reproduce it. In general, include the following:

  • What was your environment?
  • What was the expected behaviour vs. what was the actual behaviour?
  • Steps to reproduce.
  • Any other information you feel is relevant.

Feature Requests

Feature requests are always welcome, but please detail your feature request in full, and explain how it would fit into the current project.

Pull Requests

Pull requests are always welcome, but please open an issue before embarking on any significant pull request.

Coding Conventions

  • Add unit test coverage for new code.
  • If your changes involve a new hardware platform, please consider adding it to the examples/ directory.
  • Pre-commit hooks and continuous integration will ensure the project coding style is followed when making changes.