diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000000000000000000000000000000000000..eefca2e4ce2ffa4e694ec062e341a5c004bbc141 Binary files /dev/null and b/.DS_Store differ diff --git a/Docs/ContributionProcess.md b/Docs/ContributionProcess.md new file mode 100644 index 0000000000000000000000000000000000000000..6ef04c84699b5ded8bae0ffc655c57f1a37e902a --- /dev/null +++ b/Docs/ContributionProcess.md @@ -0,0 +1,47 @@ +# How To: Contribute to this Repo +This documentation article provides a simple explaination about how to contribute to this repo covering all the GitLab and VSCode ends of things. + +## Step 1: Create an Issue +What are you trying to do? +Create an issue +<img src="Images/Screenshot 2023-03-10 at 12.14.58.png"/> + +Fill out the details +<img src="Images/Screenshot 2023-03-10 at 12.30.33.png" /> + +## Step 2: Create a merge request (MR) +This will create the bracnh that you'll use to develop on. + +Click this: +<img src="Images/Screenshot 2023-03-10 at 12.32.53.png"/> + +Fill out the details: +<img src="Images/Screenshot 2023-03-10 at 12.36.35.png" /> + +<img src="Images/Screenshot 2023-03-17 at 19.24.06.png" /> + +## Step 3: Checkout the branch & Make the change +Click the button to copy the branch name +<img src="Images/Screenshot 2023-03-17 at 17.11.44.png"> + +- Open Your code editior, in the case Visual Studio Code (VSCode) and use git to checkout that branch: + +- In VSCode hit CRTL (Or CMD) + Shift + P to open the Command Palette. + +- Type "Git: Checkout" and select "Git: Checkout to..." + +<img src="Images/Screenshot 2023-03-17 at 17.18.33.png"/> + +Next, enter origin/yourbranchnamehere and hit enter to checkout your branch. With your branch checked out, you can now make changes to your local copy of the branch. + +<img src="Images/Screenshot 2023-03-17 at 17.20.13.png"/> + +Commit the changes, and push the changes to sync your local branch with the Gitlab copy (the origin). + +## Step 4: Request a merge review + +Finilay, Once you are happy with your changes, complete your MR and assign it as "ready" for reviewing. + +<img src="Images/Screenshot 2023-03-17 at 17.25.44.png"/> + +## Step 5: Done! Send a message on the chat asing for a review \ No newline at end of file diff --git a/Docs/Images/Screenshot 2023-03-10 at 12.14.58.png b/Docs/Images/Screenshot 2023-03-10 at 12.14.58.png new file mode 100644 index 0000000000000000000000000000000000000000..18dc79388e3587a5164465bac9936deb0c063616 Binary files /dev/null and b/Docs/Images/Screenshot 2023-03-10 at 12.14.58.png differ diff --git a/Docs/Images/Screenshot 2023-03-10 at 12.30.33.png b/Docs/Images/Screenshot 2023-03-10 at 12.30.33.png new file mode 100644 index 0000000000000000000000000000000000000000..6a50d8bb75bb65cc5e8ffecdfe3fef0d5ec28ff6 Binary files /dev/null and b/Docs/Images/Screenshot 2023-03-10 at 12.30.33.png differ diff --git a/Docs/Images/Screenshot 2023-03-10 at 12.32.53.png b/Docs/Images/Screenshot 2023-03-10 at 12.32.53.png new file mode 100644 index 0000000000000000000000000000000000000000..12c47c0df1ad73df2f05183fac1281b6ff0cb1a1 Binary files /dev/null and b/Docs/Images/Screenshot 2023-03-10 at 12.32.53.png differ diff --git a/Docs/Images/Screenshot 2023-03-10 at 12.36.35.png b/Docs/Images/Screenshot 2023-03-10 at 12.36.35.png new file mode 100644 index 0000000000000000000000000000000000000000..03c0f9ba76ea81700e0e41f99d49d4ec18c84a23 Binary files /dev/null and b/Docs/Images/Screenshot 2023-03-10 at 12.36.35.png differ diff --git a/Docs/Images/Screenshot 2023-03-10 at 14.23.13.png b/Docs/Images/Screenshot 2023-03-10 at 14.23.13.png new file mode 100644 index 0000000000000000000000000000000000000000..8f61630562caf3b6627025581a61727d712f2508 Binary files /dev/null and b/Docs/Images/Screenshot 2023-03-10 at 14.23.13.png differ diff --git a/Docs/Images/Screenshot 2023-03-17 at 17.11.44.png b/Docs/Images/Screenshot 2023-03-17 at 17.11.44.png new file mode 100644 index 0000000000000000000000000000000000000000..50e5d8c6e6f117ab6d7552d841401919818d48d5 Binary files /dev/null and b/Docs/Images/Screenshot 2023-03-17 at 17.11.44.png differ diff --git a/Docs/Images/Screenshot 2023-03-17 at 17.18.33.png b/Docs/Images/Screenshot 2023-03-17 at 17.18.33.png new file mode 100644 index 0000000000000000000000000000000000000000..82672b1cc08c562412bfdaab93a96fbf6677ddeb Binary files /dev/null and b/Docs/Images/Screenshot 2023-03-17 at 17.18.33.png differ diff --git a/Docs/Images/Screenshot 2023-03-17 at 17.20.13.png b/Docs/Images/Screenshot 2023-03-17 at 17.20.13.png new file mode 100644 index 0000000000000000000000000000000000000000..f1ff5d9f7d2bc49b9374e88274348238a43b798b Binary files /dev/null and b/Docs/Images/Screenshot 2023-03-17 at 17.20.13.png differ diff --git a/Docs/Images/Screenshot 2023-03-17 at 17.25.44.png b/Docs/Images/Screenshot 2023-03-17 at 17.25.44.png new file mode 100644 index 0000000000000000000000000000000000000000..f5b3587fbfc20bacbaa172cfe2fd3066c41c42bd Binary files /dev/null and b/Docs/Images/Screenshot 2023-03-17 at 17.25.44.png differ diff --git a/Docs/Images/Screenshot 2023-03-17 at 19.24.06.png b/Docs/Images/Screenshot 2023-03-17 at 19.24.06.png new file mode 100644 index 0000000000000000000000000000000000000000..71d21dc0bbff24459085d645c76e6c45f2175ed2 Binary files /dev/null and b/Docs/Images/Screenshot 2023-03-17 at 19.24.06.png differ