Overview

Updates to the codeRhelpR repository are tracked using a Zenhub board. To view the board, you will need to install the ZenHub browser extension here. In the codeRhelpR workspace or board, a "story" is defines a desired change or update to the repository. The change can range from improved documentation to adding a new feature to fixing a bug. These stories are written using a Gherkin-like structure that will ensure consistency and enhance transparency when making changes to this repository.

Sometimes desired changes to the repository cannot be succinctly described in a single story. When this occurs, multiple stories are generated within an epic that defines the broader goal or desired change. As you will see below, stories and epics have different structures. Both will use the same "personas" however. Personas are used to help distinguish between different user populations of codeRhelpR. Stories, epics, and personas used this repository are defined in greater detail below.

Story Structure and Elements

SCENARIO

This section provides a brief summary of the background and intent of the desired change.

GIVEN

This section defines any necessary pre-conditions that need to be met to enact the desired change.

WHEN

This section defines the action (typically on the part of the user but not always) that will be affected by the desired change.

THEN

This section defines the desired outcome following the action defined in the WHEN statement.

AND

This section can be added following any of the above elements to add additional details the inform conditions of satisfaction for the story (i.e., when the implemented solution matches the story's intent).

NOTES

This section includes any additional information that may be useful in meeting the conditions of satisfaction that are not directly related to defining the story.

Epic Structure and Elements

CONTEXT

The broader context that led to the current component(s) of the repository that will be changed.

CURRENT SITUATION

A brief description of the current state of the repository.

DESIRED GOAL

A definition of the final desired end state.

Personas

ALEX

ALEX is a new user of codeRhelpRand has not installed or worked with the program at any stage in the past.

LOGAN

LOGAN is an existing user of codeRhelpR