|
| 1 | +<type>(<scope>): <summary> |
| 2 | + |
| 3 | +<Describe the motivation behind this change - explain WHY you are making this change. Wrap all lines |
| 4 | +at 100 characters.> |
| 5 | + |
| 6 | +Fixes #<issue number> |
| 7 | + |
| 8 | +# ────────────────────────────────────────── 100 chars ────────────────────────────────────────────┤ |
| 9 | + |
| 10 | + |
| 11 | +# Example Commit Messages |
| 12 | +# ======================= |
| 13 | + |
| 14 | + |
| 15 | +# ─── Example: Simple refactor ────────────────────────────────────────────────────────────────────┤ |
| 16 | +# refactor(core): rename refreshDynamicEmbeddedViews to refreshEmbeddedViews |
| 17 | +# |
| 18 | +# Improve code readability. The original name no longer matches how the function is used. |
| 19 | +# ─────────────────────────────────────────────────────────────────────────────────────────────────┤ |
| 20 | + |
| 21 | + |
| 22 | +# ─── Example: Simple docs change ─────────────────────────────────────────────────────────────────┤ |
| 23 | +# docs: clarify the service limitation in providers.md guide |
| 24 | +# |
| 25 | +# Fixes #36332 |
| 26 | +# ─────────────────────────────────────────────────────────────────────────────────────────────────┤ |
| 27 | + |
| 28 | + |
| 29 | +# ─── Example: A bug fix ──────────────────────────────────────────────────────────────────────────┤ |
| 30 | +# fix(ngcc): ensure lockfile is removed when `analyzeFn` fails |
| 31 | +# |
| 32 | +# Previously an error thrown in the `analyzeFn` would cause the ngcc process to exit immediately |
| 33 | +# without removing the lockfile, and potentially before the unlocker process had been successfully |
| 34 | +# spawned resulting in the lockfile being orphaned and left behind. |
| 35 | +# |
| 36 | +# Now we catch these errors and remove the lockfile as needed. |
| 37 | +# ─────────────────────────────────────────────────────────────────────────────────────────────────┤ |
| 38 | + |
| 39 | + |
| 40 | +# ─── Example: Breaking change ────────────────────────────────────────────────────────────────────┤ |
| 41 | +# feat(bazel): simplify ng_package by dropping esm5 and fesm5 |
| 42 | +# |
| 43 | +# esm5 and fesm5 distributions are no longer needed and have been deprecated in the past. |
| 44 | +# |
| 45 | +# https://v9.angular.io/guide/deprecations#esm5-and-fesm5-code-formats-in-angular-npm-packages |
| 46 | +# |
| 47 | +# This commit modifies ng_package to no longer distribute these two formats in npm packages built by |
| 48 | +# ng_package (e.g. @angular/core). |
| 49 | +# |
| 50 | +# This commit intentionally doesn't fully clean up the ng_package rule to remove all traces of esm5 |
| 51 | +# and fems5 build artifacts as that is a bigger cleanup and currently we are narrowing down the |
| 52 | +# scope of this change to the MVP needed for v10, which in this case is 'do not put esm5 and fesm5' |
| 53 | +# into the npm packages. |
| 54 | +# |
| 55 | +# More cleanup to follow: https://angular-team.atlassian.net/browse/FW-2143 |
| 56 | +# |
| 57 | +# BREAKING CHANGE: esm5 and fesm5 format is no longer distributed in Angular's npm packages e.g. |
| 58 | +# @angular/core |
| 59 | +# |
| 60 | +# Angular CLI will automatically downlevel the code to es5 if differential loading is enabled in the |
| 61 | +# Angular project, so no action is required from Angular CLI users. |
| 62 | +# |
| 63 | +# If you are not using Angular CLI to build your application or library, and you need to be able to |
| 64 | +# build es5 artifacts, then you will need to downlevel the distributed Angular code to es5 on your |
| 65 | +# own. |
| 66 | +# |
| 67 | +# |
| 68 | +# Fixes #1234 |
| 69 | +# ─────────────────────────────────────────────────────────────────────────────────────────────────┤ |
| 70 | + |
| 71 | + |
| 72 | + |
| 73 | +# Angular Commit Message Format |
| 74 | +# ============================= |
| 75 | +# |
| 76 | +# The full specification of the Angular Commit Message Format can be found at |
| 77 | +# https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit |
| 78 | +# |
| 79 | +# The following is an excerpt of the specification with the most commonly needed info. |
| 80 | +# |
| 81 | +# Each commit message consists of a *header*, a *body*, and a *footer*. |
| 82 | +# |
| 83 | +# <header> |
| 84 | +# <BLANK LINE> |
| 85 | +# <body> |
| 86 | +# <BLANK LINE> |
| 87 | +# <footer> |
| 88 | +# |
| 89 | +# The header is mandatory. |
| 90 | +# |
| 91 | +# The body is mandatory for all commits except for those of scope "docs". When the body is required |
| 92 | +# it must be at least 20 characters long. |
| 93 | +# |
| 94 | +# The footer is optional. |
| 95 | +# |
| 96 | +# Any line of the commit message cannot be longer than 100 characters. |
| 97 | +# |
| 98 | +# |
| 99 | +# Commit Message Header |
| 100 | +# --------------------- |
| 101 | +# |
| 102 | +# <type>(<scope>): <short summary> |
| 103 | +# │ │ │ |
| 104 | +# │ │ └─⫸ Summary in present tense. Not capitalized. No period at the end. |
| 105 | +# │ │ |
| 106 | +# │ └─⫸ Commit Scope: animations|bazel|benchpress|common|compiler|compiler-cli|core| |
| 107 | +# │ elements|forms|http|language-service|localize|platform-browser| |
| 108 | +# │ platform-browser-dynamic|platform-server|platform-webworker| |
| 109 | +# │ platform-webworker-dynamic|router|service-worker|upgrade|zone.js| |
| 110 | +# │ packaging|changelog|dev-infra|docs-infra|migrations|ngcc|ve |
| 111 | +# │ https://github.com/angular/angular/blob/master/CONTRIBUTING.md#scope |
| 112 | +# │ |
| 113 | +# └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|style|test |
| 114 | +# https://github.com/angular/angular/blob/master/CONTRIBUTING.md#type |
| 115 | +# |
| 116 | +# |
| 117 | +# Commit Message Body |
| 118 | +# --------------------- |
| 119 | +# |
| 120 | +# Just as in the summary, use the imperative, present tense: "fix" not "fixed" nor "fixes". |
| 121 | +# |
| 122 | +# Explain the motivation for the change in the commit message body. This commit message should |
| 123 | +# explain WHY you are making the change. You can include a comparison of the previous behavior with |
| 124 | +# the new behavior in order to illustrate the impact of the change. |
| 125 | +# |
| 126 | +# |
| 127 | +# Commit Message Footer |
| 128 | +# --------------------- |
| 129 | +# |
| 130 | +# The footer can contain information about breaking changes and is also the place to reference |
| 131 | +# GitHub issues, Jira tickets, and other PRs that this commit closes or is related to. |
| 132 | +# |
| 133 | +# ``` |
| 134 | +# BREAKING CHANGE: <breaking change summary> |
| 135 | +# <BLANK LINE> |
| 136 | +# <breaking change description + migration instructions> |
| 137 | +# <BLANK LINE> |
| 138 | +# <BLANK LINE> |
| 139 | +# Fixes #<issue number> |
| 140 | +# ``` |
| 141 | +# |
| 142 | +# Breaking Change section should start with the phrase "BREAKING CHANGE: " followed by a summary of |
| 143 | +# the breaking change, a blank line, and a detailed description of the breaking change that also |
| 144 | +# includes migration instructions. |
| 145 | +# |
0 commit comments