Contribute to the core and plugins

Jeedom is open-source software whose source code is available at GitHub and is open to contributions from third-party developers.

IMPORTANT

It is crucial to understand the proposed code without relying entirely on code generated by artificial intelligence. However, artificial intelligence can still be useful for optimization or for performing additional checks.

Prerequisites

To contribute to the development of the Jeedom core or a plugin, there are a few prerequisites you should be aware of and take into account:

• First of all, it is essential to understand and apply Jeedom’s beta testing process,
• You also need to havea GitHub user account,
• Expertise a Pull Request on GitHub,
• Understanding the language affected by the changes (PHP, JavaScript, HTML, CSS, Python, Node.js, etc.),
• Test the proposed changes to ensure they do not cause any other bugs or unintended consequences,
• Finally, knowledge of the Debian Linux system may be required, depending on the code to be developed.

Third-party developers

Whether you’re an experienced developer or not, everyone has a role to play in contributing to the development and evolution of the Jeedom solution at their own level. Various resources are available through the Jeedom documentation and forum.

INFORMATION

If you’re not comfortable making direct changes to the core or plugin files but would still like to contribute, you can always do so by creating a thread on the forum in the “Using the Jeedom Core” or the one dedicated to plugins with the tag for the relevant plugin.

Developer Documentation

We recommend that you regularly review the documentation related to core development or plugin development in order to apply the established rules and ensure compliance with Jeedom standards.

Developer Forum

In addition to the documentation, you also have access to at the forum’s developer expo that’s packed with information.

INFORMATION

This chat room is read-only by default; to participate, you must first registered as a Jeedom developer.

Contribute to the Jeedom core

Contributions to the Jeedom core must be submitted to the develop branch in the vast majority of cases, unless a branch dedicated to that feature already exists. If in doubt, we recommend opening an issue so that the maintainers can direct you to the correct branch or even create one if necessary.

IMPORTANT

If you want to submit multiple changes, you must open as many pull requests as there are fixes or features involved.

Contribute to plugins

Regarding plugins, feature requests must be submitted to the branch beta.

INFORMATION

Some plugin repositories are not publicly accessible. In that case, you can also contribute by creating a thread on the forum with the tag for the relevant plugin.

Translation Management

Translations are automatically generated in the files i18n/*.json. There is no need to edit these files, as they are regularly overwritten by a bot.

For the translation system to work, you must follow certain conventions depending on the language used:

• In PHP, not included in the report desktop/php :

  $myString = __('Ma phrase qui sera traduite', __FILE__);
  

• In PHP, in the feature desktop/php :

  $myString = '{{Ma phrase qui sera traduite}}';
  

• In JavaScript:

  var myString = '{{Ma phrase qui sera traduite}}'