From 1a222e6b26c85b2f22f6767cb2d948be9cdfaced Mon Sep 17 00:00:00 2001
From: Michael Boniface <m.j.boniface@soton.ac.uk>
Date: Sat, 22 Feb 2025 16:55:14 +0000
Subject: [PATCH] docs:added updates following review #7
---
docs/index.md | 20 ++++++++++++++++----
1 file changed, 16 insertions(+), 4 deletions(-)
diff --git a/docs/index.md b/docs/index.md
index 3379d14..741e5d3 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -271,20 +271,32 @@ acmc --help
1. Create an new issue in the [Issue Tracker](https://git.soton.ac.uk/meldb/concepts-processing/-/issues)
-2. Create a new branch for your feature or bugfix:
+2. Create a new branch for your feature
+
+You can do this from the issue page in GitLab by selecting "Create Branch", then checkout using:
+
+ ```sh
+ git checkout -b feature-branch origin/feature-branch
+ ```
+
+This works if someone has already created the branch and you want to work on it.
+
+You can also create a new branch in your local repo if it does not exist and it will be created when you push
+
```sh
git checkout -b feature-branch
```
-3. Make changes and commit them:
+
+4. Make changes and commit them:
```sh
git add .
git commit -m "Description of changes"
```
-4. Push your branch:
+5. Push your branch:
```sh
git push origin feature-branch
```
-5. Open a merge request in GitLab.
+6. Open a merge request in GitLab.
If you make changes, ensure all tests pass and code formatting is correct before submitting a merge request.
--
GitLab