From de0c344e070e5c5ba6be37163c14095a8c54163f Mon Sep 17 00:00:00 2001 From: Victor Poughon <victor.poughon@cnes.fr> Date: Tue, 13 Feb 2018 10:20:23 +0100 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4632f689ac..9225b00675 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -95,25 +95,23 @@ OTB team. * 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). +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). -Syntax is the following. - -For branches in the main repository, syntax is the following. +For branches in the main repository, the syntax is the following: ``` branch_name [otb-data_branch_name] ``` -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. +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, syntax is the following: +For branches in forks, the syntax is the following: ``` user/branch_name [user/otb-data_branch_name] ``` -Again, second branch name is optional. +Again, the second branch name is optional. -For user 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. +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). -- GitLab