Skip to content

Commit

Permalink
Document Conventional Commits closing keywords for Git commits (#1588)
Browse files Browse the repository at this point in the history
  • Loading branch information
Hyzual authored Jan 6, 2025
1 parent 6942c1b commit 6ccc931
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions languages/en/user-guide/code-versioning/git.rst
Original file line number Diff line number Diff line change
Expand Up @@ -325,12 +325,12 @@ The following keywords (case insensitive) can be used to close an artifact:
* ``Fixes`` art #123
* ``Implements`` art #123

Some variations of these keywords are handled:
Some variations of these keywords are allowed, including some from `Conventional Commits <https://www.conventionalcommits.org/en/v1.0.0/>`_:

* ``Close``/``Fix``/``Resolve``/``Implement``
* ``Closes``/``Fixes``/``Resolves``/``Implements``
* ``Closed``/``Fixed``/``Resolved``/``Implemented``
* ``Closing``/``Fixing``/``Resolving``/``Implementing``
* ``Close``/``Closes``/``Closed``/``Closing``/``chore:``
* ``Fix``/``Fixes``/``Fixed``/``Fixing``/``fix:``
* ``Implement``/``Implements``/``Implemented``/``Implementing``/``feat:``
* ``Resolve``/``Resolves``/``Resolved``/``Resolving``

When all those conditions are met, the referenced artifact's status will be changed to the first valid :ref:`"Done" semantic <done-semantic>` value. If the "Done" semantic is not defined, the first "closed" value (per "Status" semantic configuration) will be used. The artifact will be closed by a Tuleap bot named ``Tracker Workflow Manager`` with a follow-up comment explaining why it has been closed.

Expand Down
2 changes: 1 addition & 1 deletion languages/en/user-guide/trackers/usage/notification.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ access the artifact form on Tuleap.
Notification by @ mention
=========================

In :ref:`Tracker Artifact comments <artifact_comments>`, when you mention somebdy by their Tuleap username, they will also receive an e-mail notification.
In :ref:`Tracker Artifact comments <artifact_comments>`, when you mention somebody by their Tuleap username, they will also receive an e-mail notification.

This is a one-time notification, people who are notified by their username will not receive updates for new comments or changes to the artifact.

Expand Down

0 comments on commit 6ccc931

Please sign in to comment.