Workflows

Purpose: Creation and updating of workflows

Audience: Everyone

Status: Draft

Rationale

We need workflows when:

to not forget important points to be done
for collaboration (more than one person is involved in some activity, e.g. approvals are needed)
to document how we work that onboarding works better
when you need a defined process for systematically collecting, reviewing, and prioritizing multiple related items, rather than handling each one ad-hoc.

Example: Create a workflow for test case management instead of having developers create test cases individually for every bug they find.
for continuous optimizations of how we work
we plan to automate a workflow

Who: Person who sees suboptimal workflow being used When: Some informal or suboptimal workflow already exist Actions:

create issue that suggests adding or improving a workflow
use Workflow template for issue description
add the labels "documentation", "workflows" and "scope::PM"
describe in the issue:
- which problem should be solved
- which improvement is essential to solve this problem

Who: Person assigned to the issue When: During an iteration Actions:

create MR
- describing the workflow based on doc/workflows/TEMPLATE.md with Draft state
- add it in the README.md of this folder
- add line(s) to changelog in Documentation -> Workflows
- and nothing else in the MR (implementation of the workflow happens in the next step)
describe it closely to how we currently do it
keep it short and minimal, focus on the main improvement (documentation just as-is is fine, too)
If you discover new extensions or improvements, create new issues for each of them
create a follow-up issue, describing how it would be implemented:
- same labels as in Step 1.
- but now a list of tasks

Who: Product and Project Managers When: Review is requested Actions:

Note: Merging will be done via the normal MR workflow.

Who: Person assigned to the issue When: After Workflow documentation is being merged Actions:

In a new MR, change the description of the workflow's State from "Draft" to "Implemented"
possibly other fine-tuning or clarifications of the workflow
create and update issue and/or MR templates as needed
create and change label definitions as needed for the workflow
in the next iteration meeting we communicate the changes that the workflow implies for everyone