Brave Publishers Workflow (Proposal)

Brave Publishers Workflow 👷 🏗 🏙👷‍♀️

In this document we propose a system for organization and workflow to be used in Brave Publishers development.

Epic

The highest organizational unit of work, an epic represents a broad addition to the codebase.

• Epics are composed of several issues.
• Epics should be represented as a master-issue on GitHub, which lists its component issues.
• Epics should also have an associated milestone which tracks all issues in the epic.
• Epics should link to their associated spec and be approved (signed-off on) by the Spec stakeholder.
• Completion of all issues in an epic will complete the epic, master-issue, milestone, and spec.

Issue

The simplest organizational unit of work, an issue represents a single task, feature, fix, or change.

• Issues are completed by submitting a related Pull Request, having it approved, and merged into the codebase.

Spec

The Spec is a document created by an external stakeholder.

• A Spec details the requirements for a large feature or change.
• A Spec will be translated into an Epic and Master-Issue.