Skip to content

Commit 9d4e3de

Browse files
authored
Merge pull request #32 from dafyddj/docs/conv-commits
docs: update `CONTRIBUTING` docs due to config changes
2 parents 89c9384 + 0e31f0f commit 9d4e3de

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

CONTRIBUTING.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Automation of multiple processes
2929
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.
3030
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.
3131

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/>`_.
3333
The key factor is that the first line of the commit message must follow this format:
3434

3535
.. code-block:: console
@@ -71,8 +71,8 @@ formula's root directory and now ``pre-commit`` will run automatically on each
7171
pre-commit installed at .git/hooks/pre-commit
7272
pre-commit installed at .git/hooks/commit-msg
7373

74-
Linting commit messages in Travis CI
75-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
74+
Linting commit messages
75+
^^^^^^^^^^^^^^^^^^^^^^^
7676

7777
This formula uses `commitlint <https://github.com/conventional-changelog/commitlint>`_ for checking commit messages during CI testing.
7878
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
102102
- –
103103
-
104104
* - ``chore``
105-
-
105+
- Maintenance
106106
- Changes to the build process or auxiliary tools and libraries such as
107107
documentation generation
108108
- –
@@ -138,27 +138,27 @@ based upon the `type <https://github.com/angular/angular.js/blob/master/DEVELOPE
138138
- –
139139
- 0.0.1
140140
* - ``revert``
141-
- Reverts
141+
- Reversions
142142
- A commit used to revert a previous commit
143143
- –
144144
- 0.0.1
145145
* - ``style``
146-
- Styles
146+
- Style Changes
147147
- Changes that do not affect the meaning of the code (white-space,
148148
formatting, missing semi-colons, etc.)
149149
- –
150150
- 0.0.1
151151
* - ``test``
152-
- Tests
152+
- Testing
153153
- Adding missing or correcting existing tests
154154
- –
155155
- 0.0.1
156156

157157
Use ``BREAKING CHANGE`` to trigger a ``major`` version change
158158
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
159159

160-
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.
162162
To preserve good formatting of these notes, the following format is prescribed:
163163

164164
* ``BREAKING CHANGE: <explanation in paragraph format>.``

0 commit comments

Comments
 (0)