A0011 fixme-before-land¶
Rule: No FIXME is left when a branch lands.
| Code | A0011 (stable, never reused) |
| Id | fixme-before-land |
| Category | stop-gap |
| Source | spirit_level |
| Fix | by hand |
Level per tier¶
| Tier | Level | Reason |
|---|---|---|
| small | off | |
| small-workspace | off | |
| medium | off | |
| big | deny |
a FIXME is a note for the branch; a candidate while it is in work, refused when it lands |
| ai | deny |
an agent may leave itself a FIXME on its branch; the landing refuses it |
| embedded | off | |
| ui | off | |
| egui | off | |
| units-strict | off | |
| units-paranoid | off |
Parameters¶
| Name | Type | Default | Meaning |
|---|---|---|---|
markers |
list of strings | ["FIXME"] |
markers of a note to revisit before landing, matched as whole words, case-sensitive |
docs |
boolean | true |
also check doc comments |
Why¶
While a branch is in work, a FIXME is a useful note to oneself: "revisit this before it lands". It must not outlive the branch. A TODO without a tracker id is never fine (stop-gap-comments); a FIXME is fine until the landing.
In an ordinary run the lint reports each FIXME as a candidate, which shows it and fails nothing. In a landing run (spl check --landing, see Commits and landing) it reports it at the lint's level.
// FIXME: the length check is off by one for empty frames <- candidate on the branch, a finding at landing
How to fix¶
Do what the note says before landing and remove it. Work that stays for later becomes a TODO(ID) with a FEATURES.md id.
Configure¶
[lints.fixme-before-land]
level = "deny"
markers = ["FIXME"]
docs = true
reason = "why this project wants it at this level"
Allow one finding in the code with // spirit-level: allow(fixme-before-land) <reason> (waivers); the code works there too, as in [lints.A0011].