Skip to content

🧑‍🔧 Contributing

Thank you for your interest in making a contribution!

All changes, small or big, are welcome, and regardless of who you are, we are always happy to work together to make your contribution as strong as possible. We follow the Covenant Code of Conduct, so we ask you to uphold it. Be kind to everyone in the community, and please report unacceptable behavior to [email protected]

🤔 Questions, Feature Requests, and Discussions

Post any questions, feature requests, or discussions in the respective discussion board of the repositories they should be part of.

🐛 Bug Reports

Report any bugs in the respective code repository, keeping in mind to:

  • Debug and simplify the problem to create a minimal example. For example, reduce the problem to a single participant, sensor, and a few rows of data.
  • Provide a clear and succinct description of the problem (expected behavior vs. actual behavior).
  • Attach any logs you get from the console or the log file.
  • Attach test data if possible and any screenshots or extra resources that will help us debug the problem.
  • Share the commit you are running: git rev-parse --short HEAD
  • Share your OS version (e.g., Debian 10, Ubuntu 20.04, Windows 10)
  • Share the edgeapp/system functionality you are using (e.g., backups, edgeapps, etc.)

If you are not sure where to report the bug, please post it in our mail ([email protected]) and we will help you find the right place.

📚 Documentation Contributions

If you want to fix a typo or any other minor changes, you can edit the file online by clicking on the pencil icon at the top right of any page and opening a pull request using Github's website

If your changes are more complex, clone the edgebox-iot/docs repository, setup the dev environment for our documentation repository, proceed to make your changes, and add a new Pull Request.

💶 Financial Contributions

We currently maintain an Open Collective page where we accept financial contributions, including a monthly sponsorship that gives you access to the Cloud version Early Access. You can find it here.