Git Workflow Rules

Basics

Commit Messages

• Write in English
• Changed filenames are visible in the commit, so they are not needed in the message
• Describe what was changed
• It is also good to define prefix rules for your project
  • Make Commits Beautiful and Fun with Emojis
    • Commit template for emoji commits

Issue Management

• What to do with completed issues (close them, assign them back to someone — this varies by project, so ask beforehand)

Branch Management

All changes should be implemented in branches.

Branch Names

• Branch names are all lowercase
• Words are joined with -
• Use names that describe what was done
• The branch naming pattern is <change-type>/<change-description>.
  • Example: feature/task-one-gitignore-and-readme

Branching Strategy

The service development team primarily adopts a method based on GitFlow.

• References
  • What is Git-flow?
  • Git-flow: Understanding Git Branching Models

Feature Development / Regular Bug Fixes

1. Create a feature/xxx branch from dev
2. Make changes in feature/xxx and open a pull request to dev
3. Merge after review

Production Release

1. Open a pull request from dev to master
2. Merge after review

Hotfix

1. Create a hotfix/xxxx branch from master
2. Open a pull request from hotfix/xxxx to dev
3. Open a pull request from hotfix/xxxx to master

• If using GitHub, making it a Draft pull request is a good idea

4. Merge hotfix/xxxx into dev
5. Merge hotfix/xxxx into master

Merging

• When resolving conflicts, be careful not to lose any changes
• In the case of merge commit conflicts, record the conflicted files in the merge commit message

gitignore

• Auto-generated files, editor files, and OS files should be added to .gitignore and not tracked in the repository
• Reference information
  • .gitignore files can be automatically generated at gitignore.io
  • Language-specific .gitignore repository: github/gitignore

Default gitignore

$HOME/.config/git/ignore is the default ignore file, so run mkdir git under Users/hogehoge/.config and then vi ignore and enter the following to make things smoother. For reference, the following configuration excludes Terraform files and .DS_Store from Git tracking.

#  Local .terraform directories
**/.terraform/*

# .tfstate files
*.tfstate
*.tfstate.*

# .tfvars files
*.tfvars

# .DS_Store files
.DS_Store

Git Tips

• Luke, please don't use git push --force... Use git push --force-with-lease instead...
  • Even when you absolutely need git push --force, consider whether you can use git push --force-with-lease instead