All features are tracked in Redmine as an Story. You can view existing stories as examples.
Writing a Story¶
Writing a story is the first step towards new feature. You can write a
new story by selecting
Story as the Tracker
type and giving an explanation of what the new feature will afford a user to do.
The first draft of the story is likely brief and is designed to facilitate discussion with other users and developers. All discussion is captured as comments on the story. A story that is ready will have the following items:
- A clear name for the story. Typically something like: As an <user type > I want <action phrase> so that <outcome phrase>.
- User Identification
- Who is the user? This could be a generic description, a user deploying Pulp, a user using Pulp, a user consuming content from Pulp, etc.
- A brief description about what motivates this feature to exist.
- Details and specifics about behaviors and names used with/by/for the feature.
- Acceptance Criteria
- A set of pass/fail statements, each expressing a criteria of functional aspects of the feature. These are captured as checklists (an attribute on the ). This should include API specifications, CLI specifications, documentation needs, release note needs, testing criteria, or other deliverables that need to be completed to define what “done” looks like.
Story grooming is the process of preparing a story to be accepted as a Sprint Candidate, ensuring that the Story meets the standards outlined in the previous section.
To request story grooming, post a link to it to the
Pulp Story Grooming Etherpad, and optionally
#pulp-dev IRC channel on freenode and ask for a review of it. If a reviewer
agrees the story is ready, the reviewer sets the
Groomed flag on the Story.
It is the author’s responsibility to continue the conversation until the story is Groomed.
Individual contributors are free to work on any story they wish. The core Pulp developers work in sprints, and any work to be done needs to be put on a sprint. In order to be considered for inclusion in an upcoming sprint, as story must be marked as a Sprint Candidate.
To nominate a story to be included in a sprint, a story author must first get the story groomed,
and then set the
Sprint Candidate flag on the story.
Adding Stories to Sprints¶
Groomed stories marked as Sprint Candidate are discussed at a sprint planning meeting. If accepted, the story is added to the next sprint.
If the story is not accepted onto the next sprint, the story has its
Sprint Candidate flag
unset and must be re-nominated by the author for a later sprint.