Project

Profile

Help

Task #3447

closed

Document the differences between stories/tasks/issues

Added by daviddavis about 6 years ago. Updated about 5 years ago.

Status:
CLOSED - WONTFIX
Priority:
Normal
Assignee:
-
Category:
-
Sprint/Milestone:
-
Start date:
Due date:
% Done:

0%

Estimated time:
Platform Release:
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation, Pulp 2
Sprint:
Quarter:

Description

I'm a bit unclear about the differences and I wouldn't be surprised if there are differences in opinion among Pulp team members. It would be good to document definitions for each and it might be worthwhile to email out pulp-dev to get people's opinions?


Related issues

Related to Pulp - Refactor #2851: Refactor contributing section in the pulp3 documentationCLOSED - CURRENTRELEASEamacdona@redhat.com

Actions
Actions #1

Updated by daviddavis about 6 years ago

  • Description updated (diff)
Actions #2

Updated by dalley about 6 years ago

These are the definitions I wrote down during my internship.

Issue - Defect, something that is supposed to work but doesn't
Stories - New thing, something that at a future time would be expected to work
Refactor - Improvement that is by definition not visible to the user in any way (present or not present in a certain release)
Task - Like refactor but doesn't need to be released because it deals with infrastructure

By this definition of "task", a lot of "tasks" would actually be stories. I think what we actually use "task" to mean in practice is:

Task - Anything that isn't an "Issue" and is difficult to define as a "Story" or "Refactor". Which is honestly fine with me.

Actions #3

Updated by daviddavis about 6 years ago

dalley I agree with your definitions. Just to kind of build on your definitions:

  • Issue - A defect, something that is expected to work but does not.
  • Story - A new feature or new functionality, in the format "As a ROLE, I want ACTION so that REASON."
  • Refactor - Code that doesn't result in a change of behavior for the user (this includes API users like plugin writers).
  • Task - Work that doesn't require a release. Documentation would not be a task since it has to be released whereas blog post would be a task because it's not part of any Pulp release.

A couple things we could also add to the docs:

  • Some examples of each
  • Tell users they should default to "Issue" if they are unsure about how to categorize their issue. These can be sorted out at triage.
Actions #4

Updated by daviddavis about 6 years ago

  • Project changed from File Support to Pulp
Actions #5

Updated by amacdona@redhat.com about 6 years ago

  • Related to Refactor #2851: Refactor contributing section in the pulp3 documentation added
Actions #6

Updated by amacdona@redhat.com about 6 years ago

  • Tracker changed from Issue to Task
  • % Done set to 0

Another detail is how these are handled.

Issues will be triaged, but Tasks, Refactors, and Stories will need followup in the form of a "champion". The champion of a Task, Refactor, or Story will need to nominated it as a Sprint Candidate and find another developer to mark them as groomed.

Users who want to "fire and forget" should file issues only?

Actions #7

Updated by bmbouter about 5 years ago

  • Status changed from NEW to CLOSED - WONTFIX
Actions #8

Updated by bmbouter about 5 years ago

  • Tags Pulp 2 added

Also available in: Atom PDF