Skip to content

Project Workflow

Corrina Del Greco edited this page Sep 14, 2020 · 9 revisions

Project Workflow

The master branch will rarely be directly committed to. Generally we should use branches to work on each story card/issue. Once the necessary changes have been made, create a Pull Request so the changes can be reviewed, fixed, and/or merged.

Example Process

  • Update your local branch so that you have the most recent project code (git pull) and create a new branch (git checkout) for the story card you are working on:
$ git pull && git checkout -b <branch-name>

For this project, we'll use the branch naming convention lastname-storynumber. For example:

$ git pull && git checkout -b delgreco-6
  • Make and stage your changes (stage often to prevent data loss, commit when your code is working)

  • Here's a nice shortcut for staging files:

$ git add .
  • And here is the general commit form:
$ git commit -m "<commit-message>"
  • When you want to publish your branch so other people can see it, use the following form:
$ git push -u origin <branch-name>
  • Then you can create a pull request on GitHub to have your changes reviewed and merged into the master branch

Clone this wiki locally