diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 885f039aebb..0c063fb4691 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,7 +1,7 @@ ## PR Checklist Please check if your PR fulfills the following requirements: -- [ ] The commit message follows our guidelines: https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit +- [ ] The commit message follows our guidelines: https://github.com/angular/angular/blob/main/contributing-docs/commit-message-guidelines.md - [ ] Tests for the changes have been added (for bug fixes / features) - [ ] Docs have been added / updated (for bug fixes / features) diff --git a/.gitmessage b/.gitmessage index 26b38a342d8..11187b82e0c 100644 --- a/.gitmessage +++ b/.gitmessage @@ -74,7 +74,7 @@ Fixes # # ============================= # # The full specification of the Angular Commit Message Format can be found at -# https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit +# https://github.com/angular/angular/blob/main/contributing-docs/commit-message-guidelines.md # # The following is an excerpt of the specification with the most commonly needed info. # diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4034ce17edd..5959f768bb5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -103,7 +103,7 @@ Before you submit your Pull Request (PR) consider the following guidelines: 8. Run the full Angular test suite, as described in the [developer documentation][dev-doc], and ensure that all tests pass. -9. Commit your changes using a descriptive commit message that follows our [commit message conventions](#commit). +9. Commit your changes using a descriptive commit message that follows our [commit message conventions][commit-message-guidelines]. Adherence to these conventions is necessary because release notes are automatically generated from these messages. ```shell @@ -145,7 +145,7 @@ That's it! Thank you for your contribution! ##### Updating the commit message -A reviewer might often suggest changes to a commit message (for example, to add more context for a change or adhere to our [commit message guidelines](#commit)). +A reviewer might often suggest changes to a commit message (for example, to add more context for a change or adhere to our [commit message guidelines][commit-message-guidelines]). In order to update the commit message of the last commit on your branch: 1. Check out your branch: @@ -210,163 +210,14 @@ To ensure consistency throughout the source code, keep these rules in mind as yo An automated formatter is available, see [DEVELOPER.md](contributing-docs/building-and-testing-angular.md#formatting-your-source-code). -## Commit Message Format - -*This specification is inspired by and supersedes the [AngularJS commit message format][commit-message-format].* - -We have very precise rules over how our Git commit messages must be formatted. -This format leads to **easier to read commit history**. - -Each commit message consists of a **header**, a **body**, and a **footer**. - - -``` -
- - - -