Git
Some documentation around our Git process at Nansen.
Installation
You can download Git from here, or using Chocolatey as described here.
Windows users: the only setting you need to worry about during installation is "Use Git Bash only" vs "Use Git with Git bash and Windows CMD." We recommend the "Use Git Bash only" setting. All other options can be left as-is during the installation, unless you have specific preferences.
Mac users: Download the Mac installer https://git-scm.com/download/mac or install via apt-get "sudo apt-get install git-all"
Pick a tool
We recommend using the following tools for working with Git:
Visual Studio 2019 built-in Git tooling
- useful GUI interface for performing most git commands.
Git Bash
(otherwise referred to as "Command line") - the command line interface for Git. more difficult for beginners, but provides the most complete feature set and flexibility
You should already have this via downloading Git in the step above. If you can't find the Git Bash launcher:
Windows users: Add git to your System path so its accessible in all command line instances
Source Tree
(an Atlassian tool) - cross platform GUI interface –
Branch Naming
Each client may have specific needs that require their own specific branch naming conventions. However, if possible, we recommend the following:
Two main branches, master and develop.
Master would be the representation of what is currently in production
Develop would be a branch that work items are merged into. This would automatically deploy to a developer testing environment.
Specific features would have their own branches, and live in a sub folder, feature. The name of each branch should follow the format: feature/{ticket-number}-{descriptive-name}
Hotfixes should follow a similar naming structure, but live in a sub folder labeled hotfix: hotfix/{ticket-number}-{descriptive-name}
The suggested workflow for merging should follow the chart below.
Suggested Workflow
