|
Size: 4282
Comment:
|
Size: 5024
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 19: | Line 19: |
| * ✨ feat or new: New feature. Correlates to MINOR in Semantic Versioning. | * ✨ or ⭐ or 💎 feat or new: New feature. Correlates to MINOR in Semantic Versioning. |
| Line 21: | Line 21: |
| * 🐛 fix: Bug fix. Correlates to PATCH in Semantic Versioning. | * 🐛 or 🐞 fix: Bug fix. Correlates to PATCH in Semantic Versioning. |
| Line 25: | Line 25: |
| * ⚙️ config : Configuration change, e.g. modify a default. * 🌐 or 💬 i18n: Internationalization ortranslation addition, fix. |
* ⚙️ or 🛠️ config : Configuration change, e.g. modify a default. * 🌐 or 💬 i18n or l10n: Internationalization, localization, or translation addition, fix. * ♿ a11y: Accessibility. |
| Line 32: | Line 33: |
| * ✅ or 🚨: test: Adding new test or making changes to existing test | * ✅ or 🚨 or 🧪: test: Adding new test or making changes to existing test |
| Line 34: | Line 35: |
| * 🔗 upgrade: Upgrade an external dependency | |
| Line 36: | Line 36: |
| * 🔀 merge: Merge from another branch. * 🚧 wip: Work-in-progress. |
|
| Line 48: | Line 50: |
| * ♻️ refactor: A code that neither fix bug nor adds a feature. (e.g. semantic changes like renaming a variable/ function name) | * ♻️ or 🔨 or 🛠️ refactor: A code that neither fix bug nor adds a feature. (e.g. semantic changes like renaming a variable/ function name) |
| Line 50: | Line 52: |
| * ✏️ comment: Internal documentation, e.g. comments. Subset of refactor. | * ✏️ comments: Internal documentation, e.g. comments. Subset of refactor. |
| Line 58: | Line 60: |
Other: * 👌 review: Change from code review. * 📈 or 📡 telemetry, analytics, metrics, or logging * 🔊 log * ➖ removal * ➕ addition * 🔖 bookmark, tag * 📖 metadata * 📇 metadata or index * 💡 idea, comment, etc * 👕 lint * 🚑 or 🔥 hotfix * 💩 shitcode, needs refactor * 💥 breaking-change * 👥 contributor or sponsor update * 🍒 cherry-pick'ed commit * ☸️ k8s * 🐋 docker or container * ✅ Add but not ❌ Added |
|
| Line 70: | Line 93: |
| * 70c or less | * 50c soft limit, hard limit of 70c |
| Line 94: | Line 117: |
| * [[https://chris.beams.io/posts/git-commit/|How to Write a Git Commit Message]] |
Git Commit Message conventions for AngularJS
Conventional Commits format
<type>(<scope>): <subject> <body> <footer>
Where:
<type> is one of:
External-facing stuff, important to publish to users.
- ✨ or ⭐ or 💎 feat or new: New feature. Correlates to MINOR in Semantic Versioning.
- feat: add beta sequence
- 🐛 or 🐞 fix: Bug fix. Correlates to PATCH in Semantic Versioning.
- fix: remove broken confirmation message
- 🔒 security: Security-related fix, i.e. important to highlight in changelog.
- ⚡ perf: Change that improves performance. Sometimes a subset of refactor.
- ⚙️ or 🛠️ config : Configuration change, e.g. modify a default.
- 🌐 or 💬 i18n or l10n: Internationalization, localization, or translation addition, fix.
- ♿ a11y: Accessibility.
Internal repository-related:
- 🎉 initial: Initial commit of something, may not yet work.
- ⏪ revert : Revert of previous behavior, fix, or feature
- ✅ or 🚨 or 🧪: test: Adding new test or making changes to existing test
- test: ensure Tayne retains clothing
- 🔗 deps: Add, upgrade, or anything to do with an external dependency.
- 🔀 merge: Merge from another branch.
- 🚧 wip: Work-in-progress.
Internal changes, not user-facing.
- 🔧 chore: Code change that external user won't see and does not impact a feature (e.g. change to .gitignore file)
- chore: add Oyster build script
- 👷 ci: CI-related change, subset of chore.
- 💚 ci : Fix CI
- 📦 build: Build related changes (e.g. cmake, Broccoli, grunt). Subset of chore.
- 🚀 deploy or release: New version, snapshot, or deploy.
Refactor-related, i.e. does not add new features.
- ♻️ or 🔨 or 🛠️ refactor: A code that neither fix bug nor adds a feature. (e.g. semantic changes like renaming a variable/ function name)
- refactor: share logic between component1 and component2
- ✏️ comments: Internal documentation, e.g. comments. Subset of refactor.
- 📚 docs: External documentation. Subset of refactor.
- docs: explain hat wobble
- 🎨 style: Style change, like improving structure or formatting. Subset of refactor.
- style: convert tabs to spaces
- style: format w/ black
- 🚚 rename: Move files. Subset of refactor.
- 🗑 remove: Remove deprecated code no longer used. Keep as a separate commit to make it easy to revert.
Other:
- 👌 review: Change from code review.
- 📈 or 📡 telemetry, analytics, metrics, or logging
- 🔊 log
- ➖ removal
- ➕ addition
- 🔖 bookmark, tag
- 📖 metadata
- 📇 metadata or index
- 💡 idea, comment, etc
- 👕 lint
- 🚑 or 🔥 hotfix
- 💩 shitcode, needs refactor
- 💥 breaking-change
- 👥 contributor or sponsor update
- 🍒 cherry-pick'ed commit
- ☸️ k8s
- 🐋 docker or container
- ✅ Add but not ❌ Added
<scope> refers to the module or component. Examples:
- init
- runner
- watcher
- config
- web-server
- proxy
<subject> is the first line of the commit message, and:
- 50c soft limit, hard limit of 70c
- Uses imperative, present tense. "add" vs "adds" or "added", "fix" vs "fixes" or "fixed".
- Do not end with period
<body> should:
- Includes motivation for the change, and contrasts previous behavior/implementation vs new behavior/implementation
- Describe what the commit will do, not what you did.
- Wrap at 72c.
<footer> should:
Be one per line, and follow the git trailer format. That is, each line is a key–value pair, separated by either :<space> or <space>#.
Closes #${BUG_NO}, e.g. Closes #123 if the commit closes an issue in your issue tracker.
BREAKING-CHANGE: ${description} to describe this commit breaks previous behavior/interface.
See also:
Emoji was taken from folke/devmoji and gitmoji.dev
Good examples:
Semantic Branch Names
https://gist.github.com/seunggabi/87f8c722d35cd07deb3f649d45a31082
- feature/: New feature
- bugfix/: Bug fix
- docs/: Documentation change
- style/: Style change
- refactor/: Refactor
- test/: Adding tests, refactoring tests, etc.
- chore:/ Chore
