You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.rst
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ Automation of multiple processes
29
29
This formula uses `semantic-release <https://github.com/semantic-release/semantic-release>`_ for automating numerous processes such as bumping the version number appropriately, creating new tags/releases and updating the changelog.
30
30
The entire process relies on the structure of commit messages to determine the version bump, which is then used for the rest of the automation.
31
31
32
-
Full details are available in the upstream docs regarding the `Angular Commit Message Conventions <https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines>`_.
32
+
Full details are available in the upstream docs regarding the `Conventional Commits specification <https://www.conventionalcommits.org/en/v1.0.0/>`_.
33
33
The key factor is that the first line of the commit message must follow this format:
34
34
35
35
.. code-block:: console
@@ -71,8 +71,8 @@ formula's root directory and now ``pre-commit`` will run automatically on each
71
71
pre-commit installed at .git/hooks/pre-commit
72
72
pre-commit installed at .git/hooks/commit-msg
73
73
74
-
Linting commit messages in Travis CI
75
-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
74
+
Linting commit messages
75
+
^^^^^^^^^^^^^^^^^^^^^^^
76
76
77
77
This formula uses `commitlint <https://github.com/conventional-changelog/commitlint>`_ for checking commit messages during CI testing.
78
78
This ensures that they are in accordance with the ``semantic-release`` settings.
@@ -102,7 +102,7 @@ based upon the `type <https://github.com/angular/angular.js/blob/master/DEVELOPE
102
102
- –
103
103
-
104
104
* - ``chore``
105
-
- –
105
+
- Maintenance
106
106
- Changes to the build process or auxiliary tools and libraries such as
107
107
documentation generation
108
108
- –
@@ -138,27 +138,27 @@ based upon the `type <https://github.com/angular/angular.js/blob/master/DEVELOPE
138
138
- –
139
139
- 0.0.1
140
140
* - ``revert``
141
-
- Reverts
141
+
- Reversions
142
142
- A commit used to revert a previous commit
143
143
- –
144
144
- 0.0.1
145
145
* - ``style``
146
-
- Styles
146
+
- Style Changes
147
147
- Changes that do not affect the meaning of the code (white-space,
148
148
formatting, missing semi-colons, etc.)
149
149
- –
150
150
- 0.0.1
151
151
* - ``test``
152
-
- Tests
152
+
- Testing
153
153
- Adding missing or correcting existing tests
154
154
- –
155
155
- 0.0.1
156
156
157
157
Use ``BREAKING CHANGE`` to trigger a ``major`` version change
Adding ``BREAKING CHANGE`` to the footer of the extended description of the commit message will **always** trigger a ``major`` version change, no matter which type has been used.
161
-
This will be appended to the changelog and release notes as well.
160
+
Adding ``BREAKING CHANGE`` to the footer of the extended description of the commit message, or appending a ! after the type/scope, will **always** trigger a ``major`` version change, no matter which type has been used.
161
+
This will be highlighted in the changelog and release notes as well.
162
162
To preserve good formatting of these notes, the following format is prescribed:
163
163
164
164
* ``BREAKING CHANGE: <explanation in paragraph format>.``
0 commit comments