diff --git a/doc/source/contributor/api_contribute_guide.rst b/doc/source/contributor/api_contribute_guide.rst index 275031f42..07de77ea1 100644 --- a/doc/source/contributor/api_contribute_guide.rst +++ b/doc/source/contributor/api_contribute_guide.rst @@ -254,6 +254,73 @@ The resulting directories and HTML files looks like:    └── _static +-------------------------- +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: + +* 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. +If you do not provide this line, your submission will not +link to the Storyboard's story. + +To link a bug, add the approprite 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 `_. + -------------------------------------------- Viewing the Rendered Reference Documentation -------------------------------------------- @@ -263,4 +330,3 @@ the **index.html** file. **NOTE:** The PDF build uses a different tox environment and is currently not supported for StarlingX. - diff --git a/doc/source/contributor/release_note_contribute_guide.rst b/doc/source/contributor/release_note_contribute_guide.rst index 73cba8d7d..9a5f9ccd1 100644 --- a/doc/source/contributor/release_note_contribute_guide.rst +++ b/doc/source/contributor/release_note_contribute_guide.rst @@ -118,18 +118,87 @@ The content are gound into logical sections based in the default template used b Modify the content in the YAML source file based on `reStructuredText `_ format. +-------------------------- +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. +If you do not provide this line, your submission will not +link to the Storyboard's story. + +To link a bug, add the approprite 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 `_. + ------------------ Developer Workflow ------------------ -#. Start common development workflow to create your change: "Hello My Change" -#. Create its release notes, no major effort since title and content might be reused from git commit information: +#. Start common development workflow to create your change: "Hello My Change". +#. Create its release notes, no major effort since title and content might + be reused from the Git commit information. #. Add your change including its release notes and submit for review. --------------------- Release Team Workflow --------------------- -#. Start development work to prepare the release, this might include git tag. -#. Generate the Reno Report -#. Add your change and submit for review +#. Start development work to prepare the release. This might include a + Git tag. +#. Generate the Reno Report. +#. Add your change and submit for review.