diff --git a/README.md b/README.md index 2a5fdbcf66ba607eae2063222121ebed95f53ce7..444d8a1f31023de9fc1ed947a85962f311dd0825 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,65 @@ -# robotics_ss25 +# Repository of Robotics course -Authors: To be done. +### A collection of solutions for assignments -A collection of solutions for the assignments. +## Authors: +- Rebecca Ebert +- Xenia Krotov +- Olha Solodovnyk +## Working with our Repository + +### Setup + +1. Install git (mandatory) +2. Install VS Code (for ease of use) +3. Clone the repository use `git clone` + +### Usage + +1. Sync with main +``` +git checkout main +git pull origin main +``` +2. Create a new branch +``` +git checkout -b name-of-your-branch +``` +3. Write your code on this branch + + Keep Code small for reviewers(100 - 200 lines) + +4. Stage changes & commit +``` +git add . +git commit -m "Description of changes" +``` +5. Push the changes +``` +git push origin your-branch-name +``` +6. Open a Pull Request + 1. Go to GitHub + 2. Click "Compare & Pull Request" + 3. Summarize Your Changes + 4. Reqeust at least one reviewer + +7. Wait for Approval + +8. Merge (Squash & Merge) + +9. Delete old branch + with a button in GitHub + like this locally: + ``` + git checkout main + git branch -d name-of-your-branch + ``` +10. Sync Regularly + ``` + git checkout main + git pull origin main + git checkout your-branch + git merge main + ```