From 35a67e5227effbcb93154007407e78d5addf160d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9CKatrinBistreck=E2=80=9D?= <“katrin.bistreck@tuhh.deâ€> Date: Wed, 20 Nov 2024 16:24:18 +0100 Subject: [PATCH] adds naming convention for branches to MR --- docs/developer/merge-request.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/developer/merge-request.md b/docs/developer/merge-request.md index 9d0a860..f62ea7f 100644 --- a/docs/developer/merge-request.md +++ b/docs/developer/merge-request.md @@ -19,7 +19,7 @@ There are several ways to create a merge request within GitLab, which are explai However, we will highlight the workflow, we prefer - but feel free to make your own choice. ## Preferred merge request workflow -This is the first and preferred way to make a merge request, as it is similar to our previous UNICADO workflow. +This is the first and preferred way to make a merge request, as it is similar to our previous UNICADO workflow. Let's assume you have your own (local) feature branch, where you are developing a new feature. And let's further assume, you have forked this branch from the current main or develop branch. If not, you can do it now: @@ -36,6 +36,8 @@ If you are working on this branch locally, and it is not shared with remote ☠``` { .sh .copy } git push origin <new-branch-name> ``` +!!! note + Please be aware that your branch name **must** follow this naming convention: `feature/some-feature`, `bugfix/some-bugfix` or `documentation/some_documentation`. Otherwise you will not be able to push it. On the gitlab page of the repository in the left sidebar select **Code > Merge request** and select **New merge request** @@ -47,10 +49,10 @@ On the gitlab page of the repository in the left sidebar select **Code > Merge r - Add labels - **Create merge request** -!!! note +!!! note Choose to delete the remote branch after merge, to keep remote clean -!!! note +!!! note Choose squash as merge strategy, to keep the git history streamlined @@ -58,13 +60,13 @@ Then you have to wait for the **Merge request pipeline** to pass ✅ (and hopefu Afterwards on the page of the merge request, you can click on **merge**. Then your feature branch will be automatically merged into the remote branch of `develop` (in this example). -!!! note +!!! note As a reviewer, **don't close** the merge request. It will be closed automatically, when the merge is completed. ## Commit rules and messages {#commitrules} - Commit messages should be clear and concise. - Use **English** language. -- Use the `#` to close and refer to issues. +- Use the `#` to close and refer to issues. - Please use **present tense** to express what the commit does. - **Don't** commit code which you know is not working. -- GitLab