doc: update contributing
Compare changes
+ 11
− 8
Before contributing, please make sure that your development environment is properly configured by following this tutorial :
Sign-ups on our gitlab are disabled. If you would like to contribute, please ask for its creation on [the technical forum].
@@ -13,13 +13,15 @@ Please note we have a specific workflow, please follow it in all your interactio
@@ -13,13 +13,15 @@ Please note we have a specific workflow, please follow it in all your interactio
- Create a branch based on `master` and prefixed with your nickname. Give your branch a short name indicating the subject.
- Never contribute to a branch of another contributor! If the contributor makes a `git rebase` your commit will be lost!
@@ -30,14 +32,15 @@ Please read [Developer documentation] before contribute.
@@ -30,14 +32,15 @@ Please read [Developer documentation] before contribute.
1. Ensure that the code is well formated `cargo fmt` and comply with the good practices `cargo clippy`. If you have been working on tests, check everything with `cargo clippy --all --tests`.
1. Update the documentation with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
1. 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.
1. 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].