Thanks for taking the time to contribute :D
Before opening an issue, please check that the issue is not already opened. If there is no issue similar to yours, feel free to create an issue and follow the template.
Once you have finished your development and you want to merge it on develop, please create a pull request. The pull request must have a title explicit, for example: feat(frontend): <your feature>. Once the pull request is created, follow the template.
Tracim translation is done through Weblate.
Head over to Weblate and contribute to the translation.
You have a new feature to develop?
Let's start by opening an issue with the feature template.
Then create a branch from develop, which should be named feat/<your ticket title>.
Now you can start coding 😄
See build to see how to build Tracim. Especially the development build section.
See testing to see how to test Tracim and your developments.
First, you need to sign every commit you make with the -s arg of git commit command.
See git signature.
This will prove that you are the author of the commit and you have accepted the licenses (MIT, LGPLv3 and AGPLv3) and Developer Certificate of Origin.
To enforce most required guidelines, please use the precommit mechanism. This will perform some automatic checks before committing. This is required to contribute to Tracim.
To use it, you need the pre-commit Python package (installed with pip install -r requirements-dev.txt on the backend)
you can then install hooks with:
pre-commit install
Then, you will be able to notice the automatic checks when running git commit.
Note: the pre-commit hook requires Python 3.7 or later to work.