Skip to content

Latest commit

 

History

History
64 lines (40 loc) · 2.54 KB

CONTRIBUTING.md

File metadata and controls

64 lines (40 loc) · 2.54 KB
Raw

Contributing

Thank you for your interest in the project and for considering contributing.

This guide should help you get started: creating a build and test environment, as well as contributing your work.

All contributions are welcome! While this guide will focus on contributing code, we would also encourage you to contribute by reporting issues, providing feedback, suggesting new ideas. Or just by saying "hi" in the chat.

If you just want to run Drogue IoT cloud, take a look here: README.md#for-users.

Certificate of Origin

By contributing to this project you agree to the Developer Certificate of Origin (DCO). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution. See the DCO file for details.

Before you start

Before you start working on a fix or new feature, we would recommend to reach out to us and tell us about it. Maybe we already have this in our heads (and forgot to create an issue for it), or maybe we have an alternative already.

In any case, it is always good to create an issue, or join the chat and tell us about your issues or plans. We will definitely try to help you.

Developing

We have some detailed development instructions in a separate document: DEVELOPMENT.adoc. You can also find it in our documentation.

Contributing your work

Thank you for reading the document up to this point and for taking the next step.

Pre-flight check

Before creating a pull-request (PR), you should do some pre-flight checks, which the CI will run later on anyway. Running locally will give you quicker results, and safe us a bit of time and CI resources.

It is as easy as running:

make check

This will:

  • Check source code formatting
  • Run cargo check
  • Run cargo clippy

The clippy checks should be seen as suggestions. Take a look at them, in some cases you will learn something new. If it sounds reasonable, it might be wise to fix it. Maybe it flags files you didn't even touch. In this case just ignore them, was we might not have fixed all the clippy suggestions ourselves.

Creating a PR

Nothing fancy, just a normal PR. The CI will be triggered and come back with results. People tend to pay more attention to PRs that show up "green". So maybe check back and ensure that the CI comes up "green" for your PR as well. If it doesn't, and you don't understand why, please reach out to us.

There are bonus points for adding your own tests ;-)