diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5c21b7d5cc39f7f8d15da34465ebc504e05de45a..9225b00675847c719e0c214cf3324d4278ae8d3c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -89,10 +89,33 @@ Request against the `develop` branch on GitLab using the merge request template. The merge request will then be discussed by the community and the core OTB team. -* Merge requests can not be merged until all discussions have been resolved (this is enforced by GitLab). -* Merge requests **must receive at least 2 positives votes from PSC members** before being merged. -* The merger is responsible for checking that the branch is up-to-date with develop and that the dashboard is ok. +* Merge requests can not be merged until all discussions have been resolved (this is enforced by GitLab) +* Merge requests **must receive at least 2 positives votes from PSC members** before being merged +* The merger is responsible for checking that the branch is up-to-date with develop * Merge requests can be merged by anyone (not just PSC or RM) with push access to develop +* Merge requests can be merged once the dashboard is proven green for this branch + +Branches can be registered for dashboard testing by adding one line in `Config/feature_branches.txt` in [otb-devutils repository](https://gitlab.orfeo-toolbox.org/orfeotoolbox/otb-devutils.git). + +For branches in the main repository, the syntax is the following: + +``` +branch_name [otb-data_branch_name] + +``` +The second branch name is optional. It can be set if you need to modify [otb-data](https://gitlab.orfeo-toolbox.org/orfeotoolbox/otb-data.git) according to your changes. + +For branches in forks, the syntax is the following: +``` +user/branch_name [user/otb-data_branch_name] +``` +Again, the second branch name is optional. + +For users without push access to [otb-devutils repository](https://gitlab.orfeo-toolbox.org/orfeotoolbox/otb-devutils.git), the modification can be asked through a merge requests to this repository. + +Once the feature branch is registered for testing, it should appear in the *FeatureBranches* section of the [OTB dashboard](https://dash.orfeo-toolbox.org/index.php?project=OTB) next day (remember tests are run on a nighlty basis). + +Do not forget to remove the feature branch for testing once it has been merged. ## Remote modules