x
/
development-proposals
Code Issues Proposed changes

Updates to HACKING.rst 

Updates HACKING to include mention of initial merge with
robust discussion followed by subsequent merges with limited
scope.

Change-Id: Ief410a502e2a7221b2d05d054ccb865b9adcc52d
This commit is contained in:
Kenny Johnston 2016-06-09 11:22:24 -05:00 committed by Yih Leong Sun
parent 9f2d260ae1
commit 520876d4a1
1 changed files with 49 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
HACKING.rst
View File

@ -12,36 +12,66 @@ openstack-user-stories Style Commandments
Product WG User Story Submission Process
----------------------------------------
- Follow instructions at `Documentation/HowTo/FirstTimers <https://wiki.openstack.org/wiki/Documentation/HowTo/FirstTimers>`_
- This page will help you configure your local environment
- Clone openstack-user-stories using "git clone https://github.com/openstack/openstack-user-stories" and create a branch using "git checkout -b <branch>"
- Follow instructions at `First Timers Documentation
<https://wiki.openstack.org/wiki/Documentation/HowTo/FirstTimers>`_
- This page will help you configure your local environment
- Clone openstack-user-stories using "git clone
https://github.com/openstack/openstack-user-stories" and create a branch
using "git checkout -b <branch>".
- Document your user story using our `approved template <user-story-template.rst>`_
- Save the user story in the "user-stories" directory with a unique name
- Document relevant information about the submission in a tracker using JSON. Here is a link to the `tracker template <user-story-tracker.json>`_
- For more information on the tracker format, you can read the `Tracker Overview <doc/source/tracker_overview.rst>`_
- Save the tracker file (with as much information as you are able to provide) in the "trackers" directory using the same unique name as the user-story but ending with a .json extension
- A member of the Product WG might contact you to review the submission using the email address associated with your Gerrit user.
- Save the user story in the "user-stories/proposed" directory with a unique name
- For initial submissions of a user story expect a robust discussion around
the intent, value and content of your story
- Subsequent commits after general agreement should be more bite-sized in
conformance with `general OpenStack best practices <https://wiki.openstack.org/wiki/GitCommitMessages#Structural_split_of_changes>`_.
- Document relevant information about the submission in a JSON tracker. Here is
a link to the `tracker template <user-story-tracker.json>`_.
- For more information on the tracker format, you can read the `Tracker
Overview <doc/source/tracker_overview.rst>`_
- Save the tracker file (with as much information as you are able to provide)
in the "trackers" directory using the same unique name as the user-story but
ending with a .json extension
- A member of the Product WG might contact you to review the submission using
the email address associated with your Gerrit user.
User Story Endorsement Process
------------------------------
We might often have a user story in the repository that might be beneficial to multiple working groups or community members. If you find a user story that applies to you or your SIG (Special Interest Group) then please endorse the user story. Endorsement shows that the user story has importance to multiple groups and can help it earn a higher priority.
We might often have a user story in the repository that might be beneficial to
multiple working groups or community members. If you find a user story that
applies to you or your SIG (Special Interest Group) then please endorse the
user story. Endorsement shows that the user story has importance to multiple
groups and can help it earn a higher priority.
- Follow instructions at `Documentation/HowTo/FirstTimers <https://wiki.openstack.org/wiki/Documentation/HowTo/FirstTimers>`_
- This page will help you configure your local environment
- Clone openstack-user-stories using "git clone https://github.com/openstack/openstack-user-stories" and create a branch using "git checkout -b <branch>"
- This page will help you configure your local environment
- Clone openstack-user-stories using "git clone
https://github.com/openstack/openstack-user-stories" and create a branch
using "git checkout -b <branch>"
- Find associated tracker for the user story in the "trackers" directory
- Modify the 'supporting working groups' or 'supporting individual members' accordingly
- Modify the 'supporting working groups' or 'supporting individual members'
accordingly
User Story Tracker
------------------------------
The tracker file for the user story has to be updated once a user story has gone through the workflow and has blueprints associated with it.
The tracker file for the user story has to be updated once a user story has
gone through the workflow and has blueprints associated with it.
- Follow instructions at `Documentation/HowTo/FirstTimers <https://wiki.openstack.org/wiki/Documentation/HowTo/FirstTimers>`_
- This page will help you configure your local environment
- Clone openstack-user-stories using "git clone https://github.com/openstack/openstack-user-stories" and create a branch using "git checkout -b <branch>"
- This page will help you configure your local environment
- Clone openstack-user-stories using "git
clone https://github.com/openstack/openstack-user-stories" and create a
branch using "git checkout -b <branch>"
- Find associated tracker for the user story in the "trackers" directory
- Modify the 'blueprints/specs' with the following information:
- Project Blueprint/Spec Pertains To
- Link to Blueprint/Spec
- Status of Blueprint/Spec
- The overall completion for a user story is determined by number of blueprints/specs in completed status versus the overall number of blueprints/specs submitted against a user story.
- Project Blueprint/Spec Pertains To
- Link to Blueprint/Spec
- Status of Blueprint/Spec
- The overall completion for a user story is determined by number of
blueprints/specs in completed status versus the overall number of
blueprints/specs submitted against a user story.