diff --git a/README b/README index 1b2039628a24f8c98e1e3f362e41a30ff4940201..7edeb69fc6f8910d7d72c2d334ebbffbed0cd423 100644 --- a/README +++ b/README @@ -7,7 +7,11 @@ git-hosted version currently under development for automated tests etc. ## Policy for contributing * `master` branch is protected, changes can only be made via merge requests. * To propose changes: - * Open an issue to discuss the matter (please give link/explanation how to do that) - * Then open a branch to work on the issue (please give command to execute) - * When done, submit a merge request to the master branch. (please give series of commands to execute, examples, like "make changes", add, push, if tests passed ask for merge with command to do) - + * Open an issue to discuss the matter (in gitlab project page -> issues) + * Then open a branch to work on the issue. There are several ways to do this: + * Click on 'create branch' on the issue page on gitlab (then `git fetch` and `git checkout <branchname>`) + * In your local space, do `git checkout -b <branchname>` to create a new branch from your current `HEAD`. + * When done, `git push` the branch and submit a merge request. + * The link to open the merge request is shown following the commit. + * Assign someone (other than yourself) to review the merge request. + * Follow up on any questions/comments and optionally amend your branch (and re-push) to fix any new issues that arise. \ No newline at end of file