Contributing
Contributing to nosgestesclimat.fr
This file describes different way to contribute to the project.
This document is only documenting the contribution to the user interface of Nos Gestes Climat. If you want to contribute to the model, please refer to the corresponding documentation.
Table of content
The @datagir team thanks you to taking the time to contribute to the project! 🎉
You can start by exploring opened issues. They are used both to track feature implementations or bug corrections. Moreover, they are used to discuss about topic or to answer questions, consequently, don't hesitate to browse them to find bits of documentation if they aren't in the wiki.
To start the local development, you'll need:
# To clone the repo and its submodule on your computer
git clone --recursive git@github.com:datagir/nosgestesclimat-site.git
# To install the dependencies through Yarn
yarn install
# To run the local server in watch mode.
yarn start
The application will be available at https://localhost:8080.
See the corresponding readme section.
With Cypress, it only possible to parallelize at the spec file level.
Consequently, spec files for test completion on personas are automatically
generated with the cypress/scripts/generateSpecsFromPersonas.js script.
The project's documentation is currently maintained through this wiki. You can update its content by modifying Markdown files stored in ./docs.
For more information about contributing to the documentation, please refer to the dedicated wiki page.
The website is translated in different natural languages using the DeepL API
and the react-i18next package.
All information about the UI translation could be found here.
The computational model is built with publicodes, a programming language tool chain based on top of the YAML syntax.
You could find more information about it in the Publicodes wiki's section.
