What's in the Handbook?Schedule of Events
All About Chingu
Your Voyage
Pre-Voyage - Solo Project
Voyage - Team Project
Pair Programming Guide
Technical Resources
Choosing Your TechstackApp Mockup ToolsFonts, Icons, Images, & MoreSoftware LicensesGit - Defining a WorkflowImportance of Good PracticesSetting Up Your Local Git RepoWorking / Development / Master Branch WorkflowGit BranchesThe WorkflowReferencesGit - BranchesGit - CommitsGit - Pull Requests
Project Resources
Glossary

Git Workflow

GitHub's Octocat!

Importance of Good Practices

Your project's source code is its single most important artifact. The loss or corruption of your code base is a catastrophic event that can impact not just your project, but also your reputation as a professional developer.

This makes it critical that your team defines the process that everyone on the team will rigidly adhere to when making and promoting changes. The good news is that despite its importance, establishing a solid Git Workflow isn't difficult and both Git and GitHub are battle-tested tools.

Setting Up Your Local Git Repo

Chingu requires that our teams maintain their projects in GitHub. While there are other alternatives, such as BitBucket and GitLab, centralizing on a common cloud-based service greatly simplifies the process of familiarizing Chingu's new to git and cloud-based source code management. It also simplifies our monitoring process since there's only one such service to interface with.

Git maintains a record of your participation and activity against your teams git repo - commits, issues, pull requests, and pull request reviews to name just a few. However, in order to correctly attribute the work you perform to you they have to know who you are. This is important since prospective employers will use the metrics in your GitHub profile to evaluate your capabilities, based on your project work.

To ensure that git and GitHub properly collect and attribute your activities follow these instructions to set up your GitHub user name and email address. Make sure that the email address you set up in your local git matches the email address in your GitHub Profile.

Working / Development / Master Branch Workflow

There are multiple workflow models you can choose to adopt, but if you are new to Git and GitHub, one type of Git workflow is presented here. This model is based on the assumption that your team will set up a skeleton repo in GitHub from which all team members will then clone to their computers.

Git Branches

A three-level hierarchy of branches is created, through which changes are promoted.

  • Working branches: Individual branches created by each developer when they are working on changes and bug fixes. There are 4 basic types of branches: bug, feature, refactor, and style. For example: feature/course-review. Consult the wiki for more details and examples.
  • Development: Reflects the code for the next release. Developers work in working branches, which are then pulled into this branch. All code pulled into this branch must be tested and undergo peer review as part of the PR process.
  • Master: Only updated from the development branch Pull Requests. This branch always reflects the current production release that is seen by live users.

The Workflow

Git Workflow

  1. Once the skeleton repo is built in GitHub, team members will clone it to their individual computers. Working branches are created for specific features and tasks (like bug fixes).
  2. All normal development activities occur on team members' individual computers. Commits should be frequent and each commit should have a discrete, atomic purpose.
  3. Changes should be frequently pushed to the matching working branch on GitHub. This ensures that if a computer is lost, stolen, or malfunctions, your work will still be available to the rest of your team.
  4. From time to time, you may also need to pull working branches to your individual computer. For example, you'll need to do this if/when you help another team member with one of their tasks.
  5. Once a feature has been unit tested, a Pull Request (PR) should be created to fold it into the development branch. It's always a good idea to require that PR's be reviewed by another member of the team. This helps to ensure that the quality of the app is maintained.
  6. When a group of features are ready to be promoted to Production, they should be thoroughly tested together. Then, a Pull Request should be created in order to move them into the master branch which reflects the code base that's in Production or soon to be promoted to Production.
  7. Once the PR to the master branch has been completed, you are then ready to release its contents into your Production runtime environment.

References

Copyright2021 Chingu Cohorts