58 lines
1.3 KiB
Markdown
58 lines
1.3 KiB
Markdown
# PR#999: Title of the PR
|
|
|
|
Version: minor
|
|
|
|
> **WARNING:** This document describes only the change applied in this PR.
|
|
> It may already be outdated once the next PR is merged.
|
|
> Historic PR documentation is not maintained along with new PRs; treat it as a snapshot.
|
|
|
|
## Problem
|
|
|
|
The problem this PR solves, in prose.
|
|
|
|
## Non-Goals
|
|
|
|
What this PR deliberately does not do, to delimit the scope.
|
|
|
|
## Specification
|
|
|
|
Requirements in Markdown-native pseudo-Gherkin, one aspect per scenario.
|
|
|
|
### Feature: headline of the feature
|
|
|
|
#### Scenario#999.01: a requirement in the shape of a scenario
|
|
|
|
… so that … (the goal behind the requirement), in lower case after the ellipsis.
|
|
|
|
- **Given** a precondition
|
|
- **When** something is done
|
|
- **Then** a postcondition
|
|
|
|
##### Verified by
|
|
|
|
- [test_module.TestClass.test_name](../../tests/test_module.py)
|
|
|
|
## Solution
|
|
|
|
The changes and why they were necessary; keep it short.
|
|
|
|
## Open Questions
|
|
|
|
Decisions left open for the reviewer or a follow-up, each with the implemented behavior.
|
|
Every item needs a checkbox: `- [ ]` blocks the review (RED), `- [x]` marks it as answered.
|
|
|
|
- [x] An answered question?
|
|
The answer, on an indented continuation line of the same item.
|
|
|
|
## Additional Changes
|
|
|
|
By-catches of this PR.
|
|
|
|
## Prerequisite PRs
|
|
|
|
PRs this PR builds upon.
|
|
|
|
## Follow-up PRs
|
|
|
|
Work deferred to later PRs.
|