# Git Flow

For introduction to git, please see section [Git Intro](https://github.com/Spartronics4915/developers_handbook/tree/a6c97de8576447812f67134350fb825ce4ea738f/git_intro/README.md)

* [Spartronics Git Workflow](#spartronics-git-workflow)
  * [Overview](#overview)
    * [Resources](#resources)
  * [Workflow Steps](#workflow-steps)
  * [Top 5 Commands](#top-5-commands)

## Overview

The Spartronics Programming Team uses GitHub's *fork & pull request* workflow. This workflow balances flexibility with productivity for the individual developers.

* Individuals have the flexibility of working on their own repos, while

  collaborating as a small team, such as pair programming or getting code

  reviews from mentors before a pull request (PR)
* Standard practice is for developers to push their local repos to their

  remote forks, ensuring code continuity and code backup
* Programming leads can monitor and review code contributions and ensure

  that the *master* branch is always production ready

### Resources

* [GitHub Guides: Forking Projects](https://guides.github.com/activities/forking/)
* [GitHub Gist: GitHub Forking](https://gist.github.com/Chaser324/ce0505fbed06b947d962)

## Workflow Steps

![Fork & PR Workflow](https://2124815507-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LRKIIRSeTTGWQoN_IjS%2F-Lt33AYW_-1dgHjzlF6s%2F-Lt33BUcvzT7iDpGtaza%2Frepos.png?generation=1573099982325070\&alt=media)

Basic git commands and process flow is documented [here](https://spartronics4915.gitbook.io/developer-handbook/git_fundamentals#git-fork). If you are new to git, please start with our [Git Intro](https://spartronics4915.gitbook.io/developer-handbook/git_introduction).

Start with forking the team repo on GitHub and cloning your repo on your computer. This command is handy to stay in sync with the *upstream* branch: `$ git pull upstream master`.

1. Make changes on your local repo
2. Test changes on the robot
3. `git add` the changed files
4. `git commit` to package and document the changes
5. `git push origin master` to send the commits to GitHub
6. Make a pull request at your fork's GitHub page
7. Make changes as requested in the review process, and push them to GitHub
8. `git pull upstream master` after the pull request is accepted and merged

## Top 5 Commands

1. `git status`
   * Shows the current status of your git repository, including:
     * What files you've edited (shown in red until you `git add` them)
     * What you've deleted (shown in red until you `git add` them)
     * What things are ready to be committed (shown in green)
     * Whether you have any conflicts (shown in a different color)
     * Whether your code has been pushed to your fork ("Your branch is up-to-date...")
2. `git add/stage <file1> <file2>`
   * Adds ("stages") files to the index, which is where `git commit` pulls

     &#x20; changes from
   * You can just use `git add src` to add every change you've made inside the

     &#x20; `src` folder.

     * Please make sure you actually intend to commit EVERYTHING you change

       &#x20; inside that folder before you run this.
   * Before moving on, it is worthwhile to use `git status` to double-check the

     &#x20; list of files you want to add
3. `git commit`
   * Takes the changes staged by `git add` and records them as a new commit
   * When you run this, it opens the `vi` editor by default, so you can write a

     &#x20; message for your commit. See the readme for instructions on using `vi`
   * You can also use `git commit -m "your message in quotes here"` to write a

     &#x20; short message directly
4. `git pull`
   * Pulls down commits from the specified remote
   * Most often used like `git pull upstream master` -- this means "pull the

     &#x20; `master` branch from the `upstream` remote
   * You need (well, you should) do this both daily and before using

     &#x20; `git push`, to ensure your changes don't cause conflicts
5. `git push`
   * Pushes your commits to a remote
   * Most often used like `git push origin master` -- "push the `master`

     &#x20; branch to `origin`"
   * Do this frequently to make sure your changes are backed up on GitHub


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://spartronics4915.gitbook.io/developer-handbook/git_introduction/git_flow.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.