Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Differences between task, bug, improvement, new feature, and the like:

...

  • NEW FEATURE: When you propose a new feature that is necessary to complete a user story
  • TASK: When you are not sure about the category, just use this

...

(star)Note: If you see a new feature belonging to a user story, then link it there. Otherwise, just file a new user story. The project manager will break it down

Example of user story:

A user story is always written using natural language, in this form

"As a <type of user>, I would like to <desired goal> such that <desired outcome>"

E.g. "As a board member of my antenna, I would like to see where my members attend events such that I can have prizes for the ones who travelled the most"

At that point, the project manager will add the corresponding tasks to achieve this goal (in the form of "new feature").

...

Since we are working with lots of different people it is important we record issues in a clear consistent and concrete way, therefore these guidelines should always be followed. (Not just in OMS-General, but in every module)
This page is based on the official JIRA constants page, however, stick to the convention laid out here when working on the OMS project. 

Issue types

JIRA is used as an issue tracker, here the term 'issue' is a very vague term, it does not necessarily mean that something is wrong with the software (a bug) but can also be a new feature.
An issue can be one of the following:

  • Image AddedBug
    • A problem which impairs or prevents the functions of the product.
  • Image AddedTask
    • A (small) task that needs to be done.
  • Image AddedImprovement
    • An improvement or enhancement to an existing feature or task.
  • Image AddedNew Feature
    • A suggested new feature of the product, which has yet to be accepted to be included in the final product.
  • Image AddedStory
    • A simple feature, or action. (Accepted to be included in the final product)
    • A concrete single feature or action, often part of a bigger epic
  • Image AddedEpic
    • A more complicated feature or action which needs to be broken down. (Accepted to be included in the final product)
    • A larger concept of a set of features or actions

When filing a new issue, think about what kind of issue it is and if unsure label it as a task.

Story vs Epic

We have had an internal discussion about when to use a story and when to use an epic. The conclusion was that there is no real definition to either or on the difference between them. In the end, we decided to mostly go with epics because these have some extra functionality such as having sub-stories and some filter options in the dashboard. The definition we will use for an epic will be 'A larger concept of a set of features or actions', the definition of a story will be 'A concrete single feature or action, often part of a bigger epic'.

Issue syntax

When creating a new issue please take the following conventions in account:

  • Formulate the summary in a short, clear and imperative way
    • Add a couch surfing mechanism
    • Give newly registered users an O365 account
  • Formulate the description in an explaining and natural way
    • As an AEGEE-member, I would like to use the OMS to easily find a place to couch surf.
    • As a newly registered user, I would like to receive an office-365 account for personal use.
  • Add examples and other information at the end of the description
  • Make it clear, avoid confusion


Priorities

For the priorities we will use the standard definitions given by JIRA:

  • Image Added Highest
    • This problem will block progress.
  • Image Added High
    • Serious problem that could block progress.
  • Image Added Medium
    • Has the potential to affect progress.
  • Image AddedLow
    • Minor problem or easily worked around.
  • Image AddedLowest
    • Trivial problem with little or no impact on progress.

When in doubt assign the 'Medium' priority

When in doubt just add your idea, we will manage it (heart)