Contributing to OS2iot
Thank you for contributing!
We understand that creating a public IoT standard like this, can only be set in collaboration with as many public technologists, policy makers and interested folk as possible. Thus we appreciate your input, enjoy feedback and welcome improvements to this project and are very open to collaboration.
We love issues and pull requests from everyone. If you’re not comfortable with GitHub, you can use our community to give your feedback at https://os2iot.os2.eu
Problems, suggestions and questions in issues
Please help development by reporting problems, suggesting changes and asking questions. To do this, you can create a GitHub issue for this project in the GitHub Issues for OS2iot within the relevant folder.
If your input concerns:
The user interface - select: https://github.com/OS2iot/OS2IoT-frontend/issues
The backend - select: https://github.com/OS2iot/OS2IoT-backend/issues
Docker - select: https://github.com/OS2iot/OS2IoT-docker/issues
The documentation - select: https://github.com/OS2iot/OS2IoT-docs
You don’t need to change any of our code or documentation to be a contributor!
For any security related issues, please do not open a public GitHub issue. Instead, email them to firstname.lastname@example.org.
Documentation and code in pull requests
If you want to add to the documentation or code of one of our projects you should make a pull request.
If you never used GitHub, get up to speed with Understanding the GitHub flow or follow one of the great free interactive courses in the GitHub learning lab on working with GitHub and working with MarkDown, the syntax this project’s documentation is in.
This project is MPL-2.0, which essentially means that this project, is in the public domain, and any fixes and enhancements to the code of this project must be shared with OS2 and the public domain. However, you are still allowed to combine the code of this project, with code under other licenses (open or proprietary).
1. Make your changes
This project uses the GitFlow branching model and workflow. When you’ve forked this repository, please make sure to create a feature branch following the GitFlow model.
Add your changes in commits with a message that explains them. Document choices or decisions you make in the commit message, this will enable everyone to be informed of your choices in the future.
If you are adding code, make sure you’ve added and updated the relevant documentation and tests before you submit your pull request. Make sure to write tests that show the behavior of the newly added or changed code.
2. Pull request
When submitting the pull request, please accompany it with a description of the problem you are trying to solve and the issue numbers that this pull request fixes.
All contributions have to be reviewed by someone.
It could be that your contribution can be merged immediately by a maintainer. However, usually, a new pull request needs some improvements before it can be merged. Other contributors (or helper robots) might have feedback. If this is the case the reviewing maintainer will help you improve your documentation and code.
If your documentation and code have passed human review, it is merged.
Your ideas, documentation and code have become an integral part of this project. You are the open source hero we need!
Please remember to fork the code in any circumstances when using OS2iot and follow OS2’s code of conduct