Contribute

Licence agreement and contribution guideline

First off, thanks for taking the time to contribute!

We are happy that you are interested in contributing to nymea!

Contribute


The main repositories of nymea are nymea:core, nymea:app and nymea:plugins.

  1. nymea-core:

    nymea-core (the core) is an application written in Qt and contains the whole communication with the hardware, loads the supported plugins and devices and manages all devices and rules. The core provides a JSON-RPC API to allow clients to communicate with the core.

  2. nymea-plugins:

    Here’s our collection of readily available plugins for the nymea IoT server. Not finding your device? If you are a developer, get started with creating your plugin here.

  3. nymea-app:

    the nymea-app is a front end nymea client built using Qt. For full description, please check our wiki.

  4. nymea-cli:

    the nymea-cli (command line interface) is an admin tool written in python to communicate with the nymea JSON-RPC API and test functionality of nymea.

But make sure to also check out the others, like nymea-cli, nymea-networkmanager, nymea-mqtt etc. You can find them in our organization's GitHub.

Get in touch


You can always ask a question on our
 forum about any issues or questions you have.

If you want to chat with us directly, there is also a chat group in  Telegram, where we are very active.

Furthermore, you can check our wiki for a quick guide on how to work with nymea here.

For detailed developer documentation, please go to our official documentation here


License Agreement


We’re required to have a signed agreement with everyone who puts effort in the development. It’s the easiest way for you to give us permission to use your contributions. Technically, with this agreement, you’re giving us a licence, but you still own the copyright — so you still have the right to modify your code and use it as you see fit. When you are ready to contribute to nymea, please make sure to have filled in this document and you've sent it to us using developer@guh.io


Coding style

Since nymea was written in C++ framework Qt, the coding style was taken over from Qt. The coding style guidelines and instruction can be found here:

http://qt-project.org/wiki/Qt_Coding_Style | Qt coding style

http://qt-project.org/wiki/Coding-Conventions | Qt coding conventions