https://github.com/w666/git-guidelines
This is a very opiniated guideline used in my team. Parts of it are based on other guidelines. Some parts are based on my experience what I find useful.
https://github.com/w666/git-guidelines
git guidelines tldr
Last synced: about 1 month ago
JSON representation
This is a very opiniated guideline used in my team. Parts of it are based on other guidelines. Some parts are based on my experience what I find useful.
- Host: GitHub
- URL: https://github.com/w666/git-guidelines
- Owner: w666
- License: mit
- Created: 2025-10-25T21:01:55.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-10-25T21:24:18.000Z (8 months ago)
- Last Synced: 2025-10-25T23:21:45.977Z (8 months ago)
- Topics: git, guidelines, tldr
- Homepage:
- Size: 1.95 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# git-guidelines
## Commit Messages
- Add issue number followed by colon `:`
- For GitHub and GitLab issue numbers use square brackets `[#123]:`
- For Jira issues brackets are not needed `PROJ-123:`
- Use the imperative, present tense: "Change" not "Changed" nor "Changes"
- Do capitalize the first letter
- Do not end the first line with a period `.`
## Branch Names
Branch names must all lowercase and follow the pattern
```bash
${BRANCH_TYPE}-${ISSUE_NUMBER}-${SHORT_DESCRIPTION}
```
for example `fix-123-handle-null-pointer`
### Branch Types
- `feature` or `feat`: when contains new feature or code refactoring
- `documentation` or `doc`: any documentation chages
- `test`: when adding tests
- `fix`: for bug fixes
## Commands
TODO