Packages

surfex

0.6.2
0.10.0 0.9.1 0.9.0 0.8.0 0.7.2 0.7.1 0.7.0 retired 0.6.3 0.6.2 0.6.1 0.6.0 0.5.24 0.5.16

Keep a specification, its tests and its code aligned: a log of which versions were confirmed to belong together, checked from source without compiling it

HexDocs Report package

Current section

Files

Jump to
Documentation
Changelog
License
13 Versions
0 Dependencies
Dependants
Files
Activity
surfex priv info marks.md
Raw

priv/info/marks.md 

# Marks: the spec itself is wrong

When the tests reflect the spec and the code passes them, but the result is wrong, the
spec needs to change. Don't bend the test; mark the unit:

```
mix surfex.mark spec.md#totals --needs-update --note "totals ignore the customer's discount"
```

- A mark records the unit's current version. It stays **open** while the unit is at that
  version, and is **resolved** when the spec changes. It is **orphaned** if the unit goes.
- Status lists open and orphaned marks in every report; `--no-marks` fails on them.
- Withdraw one that was wrong: `mix surfex.mark spec.md#totals --withdraw --note N`.
- `mix surfex.draft spec.md#totals` writes the marked unit up as a change draft for the
  project's process (`mix surfex.info drafts`).