diff --git a/doc/source/contributor/doc_contribute_guide.rst b/doc/source/contributor/doc_contribute_guide.rst index 0448021a6..3568f55f5 100644 --- a/doc/source/contributor/doc_contribute_guide.rst +++ b/doc/source/contributor/doc_contribute_guide.rst @@ -334,6 +334,75 @@ in the TOC along with the existing guides: contributor/index my_guide/index +-------------------------- +Closing Out a Bug or Story +-------------------------- + +If you are modifying a document as a result of a defect or +feature that is associated with a StoryBoard Story or Launchpad +Bug, you must take steps to link your submission (Gerrit Review) +to the story or bug. + +To link a story, add the following lines in your +commit message. +Be sure to use the actual story ID and task ID with the commit: + +* Story: $story_id +* Task: $task_id + +Following is an example that links a Gerrit Review with Story +2003375 and Task 2444: + +:: + + Change the tox.ini directory regarding tox.ini dependencies + + Story: 2003375 + Task: 24444 + +**NOTE:** You must provide a blank line before the lines +used to identify the Story and the Task. +Furthermore, you must place these lines as the last lines +in your commit message. +If you do not follow these guidelines, your submission will not +link to the Storyboard's story. + +To link a bug, add the appropriate lines in your commit message. +Be sure to provide the actual bug numbers: + +* Closes-Bug: $bug_id +* Partial-Bug: $bug_id +* Related-Bug: $bug_id + +If your fix requires multiple commits, use "Partial-Bug" +for all the commits except the final one. +For the final commit, use "Closes-Bug". + +Following is an example commit message that closes out bug +1804024: + +:: + + AIO Hardware Requirements: Updated AIO HW requirements. + + Added Small HW form factor information simplex/duplex + AIO hardware requirements. + + Closes-Bug: #1804024 + +When you associate a story or bug with a Gerrit review, Gerrit +automatically updates the status of the story or bug once the +commit is merged. +Again, be sure to provide a blank line just before the line +identifying the bug. + +You can find more information on the StarlingX code submission +guidelines on the +`wiki `_. + +To see the list of defects against StarlingX, see the +`Launchpad Application `_. + -------------------------- Building the Documentation --------------------------