Skip to content

Commit 58777ac

Browse files
committed
docs(HACKING): update example about priority
Signed-off-by: Callahan Kovacs <[email protected]>
1 parent b465170 commit 58777ac

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

HACKING.rst

+6-4
Original file line numberDiff line numberDiff line change
@@ -197,12 +197,14 @@ In other scenarios, multiple types could be appropriate because of the nature
197197
of the commit. This can happen with ``test`` and ``docs``, which can be used
198198
as types or scopes.
199199

200+
The types above are ordered by descending priority. The first appropriate type
201+
should be used.
202+
200203
For example, refactoring a test suite could have the header
201-
``test(project): reorganize tests`` or ``refactor(test): reorganize project
202-
tests``.
204+
``test(project): reorganize tests`` or
205+
``refactor(test): reorganize project tests``. ``refactor`` has a higher
206+
priority than ``test``, so the latter option is correct.
203207

204-
The types above are ordered by descending priority. The first appropriate type
205-
should be preferred.
206208

207209
Scope
208210
#####

0 commit comments

Comments
 (0)