Contribute

There are many ways to contribute to nymea. You do not need to be a developer: documentation updates, testing feedback, device information, translations and community support all help improve the project.

GitHub is the main place for contribution work because issues and pull requests are persistent, searchable and reviewable. Telegram is available for community chat, quick questions and coordination.

Translations

Translation updates are handled through the source repositories. If you want to update an existing translation or add a new language, open an issue or pull request on GitHub.

Documentation

Documentation is hosted in the nymea-docs repository. Documentation fixes and extensions are welcome there. Use pull requests for concrete changes, such as fixing outdated instructions, improving examples or adding missing sections. If you are not sure where a change belongs, open a GitHub issue first and describe what should be updated.

Testing and bug reports

Bug reports and feature requests should be filed on GitHub. Please include the affected component, the nymea version, relevant logs and a short description of what you expected to happen. If you are unsure whether something is a bug, ask in the Telegram community first or open an issue with the information you have.

Community support

The Telegram community is the place for quick questions, setup help and coordination with other users. Helping others, writing how-tos, publishing examples or sharing working setups is also a valuable contribution.

Device and hardware support

If you have a device that is not supported yet, open a GitHub issue with as much information as possible: product name, model number, protocol, API documentation, logs and links to technical resources. Depending on the device, test hardware or access to a test setup may be needed to add support.

Code contributions

nymea is developed on GitHub. For code contributions, file a pull request in the appropriate repository. Plugin submissions can be opened against the nymea plugins repository or another matching plugin repository.

Some contributions may require a contributor agreement. If that applies to your change, we will let you know during review.

All nymea code repositories can be found on GitHub.