-
* fix * doc(end2end): detail test users * doc(all): update docker tag update docker image name from 0.2.0 to 0.3.0 use "docker compose" everywhere instead of "docker-compose" improve table of content fix layout * doc(all): improve docs add logo to readme add table of content rewording complete * doc(all): fix typos
* fix * doc(end2end): detail test users * doc(all): update docker tag update docker image name from 0.2.0 to 0.3.0 use "docker compose" everywhere instead of "docker-compose" improve table of content fix layout * doc(all): improve docs add logo to readme add table of content rewording complete * doc(all): fix typos
After you've reviewed these contribution guidelines, you'll be all set to
contribute to this project.
CONTRIBUTING.md 2.36 KiB
Contributing
Before contributing, please make sure that your development environment is properly configured by following this tutorial :
Setting up your development environment
Sign-ups on our gitlab are disabled. If you would like to contribute, please ask for its creation on the technical forum.
When contributing to this repository, please first discuss the change you wish to make via issue or via the technical forum before making a change.
Please note we have a specific workflow, please follow it in all your interactions with the project.
Developer documentation
Please read Developer documentation before contribute.
Workflow
- Create a branch based on
masterand prefixed with your nickname. Give your branch a short name indicating the subject. - Create an MR from your branch to
master. - Never contribute to a branch of another contributor! If the contributor makes a
git rebaseyour commit will be lost! - Before you push your commit:
- Apply formatters (rustfmt and prettier) and linter (clippy)
- Document your code
- Apply the project's git conventions
Merge Process
- Ensure you rebased your branch on the latest
mastercommit to avoid any merge conflicts. - Ensure that you respect the commit naming conventions.
- Ensure that all automated tests pass with the
cargo testcommand. - Ensure that the code is well formated
cargo fmtand comply with the good practicescargo clippy. If you have been working on tests, check everything withcargo clippy --all --tests. - Update the documentation with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
- Push your branch on the gitlab and create a merge request. Briefly explain the purpose of your contribution in the description of the merge request.
- Tag a Duniter reviewer so they will review your contribution. If you still have no news after several weeks, tag another reviewer or/and talk about your contribution on the technical forum.