Git and GitHub Instructions - Jacob1225/pufferfish-minecraft-mod GitHub Wiki

Our project uses GitHub to store the code repository. Pull requests are opened when features are ready to be merged into the main branch. Other team members must do a code review before the pull request is merged into the main branch. Issues with any of the features are added as new tasks on Jira.

Git commands: Cheatsheet for git commands

Protocol for working collaboratively in GitHub:

1. Work on your branch (Name the branch to reflect the Jira issue that is being worked on. Ex. TP-#-Description)
2. When done, commit and push code to your branch
3. Checkout to main branch
4. Pull main to get latest code
5. Checkout to your branch
6. Merge main into your branch
7. Fix any conflicts
8. Commit and push to your branch
9. Open a pull request and have the code be reviewed and approved to merge into the main branch by another team member

It is essential that we follow these procedures to ensure that the main branch is up-to-date and conflicts do not occur.