fome-fw/CONTRIBUTING.md

1.4 KiB

How to contribute

The FOME project is always looking for new contributors, so thanks for your interest!

Submitting changes

Create a GitHub Pull Request with your changes to have it reviewed by the maintainers.

Be descriptive in the description and your commit messages about what the PR does. The more information and context, the better. Referencing GitHub issues and pull requests is great.

Each pull request should be atomic: include the minimum set of changes to go from one working configuration to another. If you want to fix multiple bugs or add multiple features, split them up for one PR per distinct issue.

Testing

All PRs must pass CI gates (should see a next to the last commit) to be merged. Many builds are run (firmware for all boards, unit tests, etc) and need to all be passing before something is merged. You should of course test yourself instead of being surprised with an next to your build!