Skip to content

Commit 813e3ab

Browse files
committed
doc: Update contrib doc with Tracked-On
For traceability, all changes must include a Tracked-On: line indicating the issue driving this change. Signed-off-by: David B. Kinder <david.b.kinder@intel.com> Tracked-On: #1420
1 parent 30c2901 commit 813e3ab

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

doc/developer-guides/contribute_guidelines.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -275,6 +275,12 @@ source files for the hypervisor, devicemodel, and documentation:
275275
agreement with the `DCO`_. See the `Commit Guidelines`_ section
276276
below for specific guidelines for writing your commit messages.
277277

278+
All commits must be mapped to a GitHub issue for a feature or bug. Add a
279+
``Tracked-On: #issue-number`` line to your commit message together
280+
with the issue number, for example::
281+
282+
Tracked-On: #1420
283+
278284
#. Push your topic branch with your changes to your fork in your personal
279285
GitHub account::
280286

@@ -367,9 +373,10 @@ Changes are submitted as Git commits. Each commit message must contain:
367373
* A Signed-off-by line, ``Signed-off-by: <name> <email>`` typically added
368374
automatically by using ``git commit -s``
369375

370-
* If the change addresses an issue, include a line of the form::
376+
* For traceability, all changes must include reference to a GitHub
377+
issue. Include a line of the form::
371378

372-
Fixes #<brief description about the reported issue>.
379+
Tracked-On: #issue-number
373380

374381

375382
All changes and topics sent to GitHub must be well-formed, as described above.

0 commit comments

Comments
 (0)