This will be how we collaborate on this project
We will be using Github Desktop, which each of you should have installed.
Create a fork by press the Fork button on the top right of our repository's homepage
In Github Desktop, under the repositories tab select "Add/Clone Repository". Select the repository that starts with your username, like "myname/doodlejump"
In Visual Studio, just write your code in the already created methods/functions provided. Feel free to create more as you wish.
However, avoid writing code in the same spot as your filemate. The conflicts between your versions of code could result in annoying conflicts. Communication is key!
Commit smaller changes to your branch often. Not only is it a log of what you have done, but it is something to look back to if something goes wrong or gets deleted. You can always revert what you have committed.
Don't forget to occasionally sync with Github servers by pressing the top right button that either reads Fetch, Push, or Pull Origin. Do this before and after you work on it.
When you think your changes are stable (they work or at least dont cause errors) and want to share with the rest of the group, follow these steps:
- Make sure all of your changes are committed on your fork
- Sync once more to be sure
- Under "Branch", select "Create Pull Request"
- Make sure the base repository is listed as "SHC-Robotics-Team-8255/Doodle-Jump" with base "main" and the head repository (your fork) is listed as "yourusername/Doodle-Jump-Machine-Learning" and comparing your main branch.
- You are going to see an overview of all of the changes you have made. See if everything checks out, then select "Create Pull Request"
- Once you press that, give your pull request a descriptive name and a description that tells me everything one would need to know about your changes.
- At the top right, under Reviewers, click the gear icon. Enter my username, 22preich, and select it. Do not press merge.
- After it has been merged, under "Branch" select "Rebase this branch"
- Select the upstream branch and click through all the warnings.
And you are done! Well, almost. Once I quickly check your code for any problems and merge it, you will probably want to get the latest version of code from the group repository.
- In GitHub Desktop, under Branch, select "Compare to Branch"
- Under "Other Branches, select "upstream/main"
- At the bottom, click "Merge into main"
- Now all of the changes to the official repository will be reflected onto your repository.