# Simple Git Guide

:::warning
:bulb: **MAIN NOT MASTER**: Sorry. These instructions assume you're using `master` as the name of your primary branch. It should be `main`, now.
:::

Hello, welcome to CoderSchool's Git Guide. There are a lot of ways to handle git on a team! Online you'll find a lot of people telling you what to do - it can get very overwhelming. So here's a simpler version from CoderSchool.

But first - of the "professional" models, the most popular is `git-flow`, and most companies use a variant of this. If you're curious about this, you can read a detailed walkthrough here: https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow

In this course, we'll instead be recommending something like this: https://blog.yipl.com.np/how-to-use-simplified-gitflow-branching-model-video-5259148fd25f

Why? We want to introduce you the _bare minimum_ when it comes to working with git. The additional complexity in the other models is mostly for production systems where you have to be very careful about what versions are released, which versions are tested, and so on. Depending on the type of product you work on, you may or may not have these requirements. For our projects, we don't really have these requirements, so we'll stick to the basics.

## High Level Guide

1. Pull to latest on master.
2. Make a new branch.
3. Commit to this branch.
4. Push branch.
5. Open PR.
6. Merge PR.
7. Update Master.

## Detailed Guide

First, assume you have already run `git clone`. Then, it's these lucky 13 steps (why are there so many??).

1. `git checkout master` (always be working in `master`)
2. `git pull` (make sure `master` is up to date)
3. `git checkout -b feature/short-description` (the name doesn't really matter, but this is a nice convention. You can either have `feature/` or `bug/`)
4. Work in your branch.
5. `git add .`
6. `git commit -m "Description of what happened."`
7. `git push origin feature/short-description`
8. Go to www.github.com, and open a Pull Request. You'll see your branch in the `branches` tab, or a little note if you just pushed.
9. Submit a pull request.
10. Get someone to review it if you can, and then click the "merge" button.
11. Close the pull request.
12. `git checkout master`
13. `git pull`