Skip to content

Developer guide

Julien Déramond edited this page Dec 16, 2022 · 7 revisions

This guide gathers good practices and elements that can help the developers to contribute to this project.

Philosophy: Consistency

Each modification of the project must respect our philosophy: consistency. A change to fix an issue or for a new feature must take into account the existing code and propagate the new rules or modification everywhere in the code.

This philosphy is applicable for technical concepts, but also for the rendering, wording and code formatting.

Issues and Pull Requests

Templates exist for issues and pull requests. They must be used and filled out in details to help with the efficiency of the core team. Too much details is better than no details.

Please don't forget to check all the elements in the lists.

GitHub Actions (CI)

Continuous integration is put in place thanks to GitHub Actions. Most of these GitHub Actions are executable locally. The detailed commands are available in our package.json in the scripts section.

Clone this wiki locally