IF Commons GitHub

Issues as typed code

0044Active

0044-issues · owner if · domain data

Requirements

FR-001checkpassing

An issue MUST be a frozen value whose status is a sum: fixed carries a non-empty proof, duplicate the number it duplicates, and wont-fix, not-a-defect and deferred their reason, so that a status without what it needs does not compile; it MUST say its severity, priority, goals, size, the engines it is about (or all) and the day it was raised.

Enforced (check): .github: cd commons/data && bun run verify — suite/issues.test.ts: issues are typed values: frozen, and each status carries what it needs

Proved by: data/suite/issues.test.ts, planning/suite/issues.test.ts

Written in: data/governance/issue.ts, data/issues/00001-enforcement-in-application.ts, data/issues/00002-ddl-guard-event-trigger.ts, data/issues/00003-sealed-row-security-scope.ts, data/issues/00004-trace-gate-inert.ts, data/issues/00005-mutation-survivors.ts and 21 more

Tests: passed: suite/issues.test.ts issues are typed values: frozen, and each status carries what it needs

FR-002checkpassing

Each library or module MUST keep its issues in an issues/ folder as one file for each, named NNNNN-slug.ts with numbers from 00001 and no gap, listed in order by the folder's mod.ts, which exports the set under the scope of the folder; a file that is not named so, a number out of place, a file that mod.ts does not list and a name that mod.ts lists with no file MUST each be found.

Enforced (check): .github: cd commons/data && bun run verify — suite/issues.test.ts: every issues folder of the library is kept as it must be: its files named and listed, each issue what its file says, every set sound, and the proof of a fixed issue resolves

Proved by: data/suite/issues.test.ts

Written in: data/governance/issue.ts, data/issues/mod.ts, data/sql/extensions/convergence/issues/mod.ts, data/sql/extensions/history/issues/mod.ts, data/sql/extensions/operations/issues/mod.ts, data/sql/presets/issues/mod.ts and 1 more

Tests: passed: suite/issues.test.ts every issues folder of the library is kept as it must be: its files named and listed, each

Cited by: Planning, physical/sources/issues, Planning sources and the store, Planning

FR-003checkpassing

A set MUST be checked: numbers from 1 with none missed or used twice, a slug in words, a date, a critical issue is P1 and a low one is never P1, engines named where not all, at least one goal, a fixed issue with a proof that is not only a review, a reason where one is owed, a duplicate of another issue that is not itself a duplicate, links to issues of the set, and citations in the form of a requirement.

Enforced (check): .github: cd commons/data && bun run verify — suite/issues.test.ts: a set is checked: numbers in order, a slug, a date, a priority that fits the severity, engines, goals, a proof, a reason, a duplicate, links and citations

Proved by: data/suite/issues.test.ts

Written in: data/governance/issue.ts

Tests: passed: suite/issues.test.ts a set is checked: numbers in order, a slug, a date, a priority that fits the severity, eng

FR-004checkpassing

Two versions of a set MUST be checked against each other so that an issue is never lost: one taken out, one whose number now names another issue and a status that moves along a path the moves do not allow MUST each be found; a finished issue MUST be able only to be reopened.

Enforced (check): .github: cd commons/data && bun run verify — suite/issues.test.ts: an issue is never lost: taking one out, renaming it or a move the state machine does not allow is found against the version before

Proved by: data/suite/issues.test.ts

Written in: data/governance/issue.ts

Tests: passed: suite/issues.test.ts an issue is never lost: taking one out, renaming it or a move the state machine does not a

FR-005checkpassing

The issues still to be done (open, in progress, deferred) MUST be listed most pressing first, by priority, then severity, then number.

Enforced (check): .github: cd commons/data && bun run verify — suite/issues.test.ts: the issues still to be done are listed most pressing first, and a finished one is not listed

Proved by: data/suite/issues.test.ts

Written in: data/governance/issue.ts

Tests: passed: suite/issues.test.ts the issues still to be done are listed most pressing first, and a finished one is not list

FR-006checkpassing

The check of the library MUST hold every issues/ folder in bun run verify: the files as FR-002 says, each issue the one its file is named for, every set sound as FR-003 says, and the proof of a fixed issue resolving (a file that exists, a test whose title is in its file, a specification that exists, a commit that exists).

Enforced (check): .github: cd commons/data && bun run verify — suite/issues.test.ts: every issues folder of the library is kept as it must be: its files named and listed, each issue what its file says, every set sound, and the proof of a fixed issue resolves

Proved by: data/suite/issues.test.ts

Written in: data/tools/issues.ts

Tests: passed: suite/issues.test.ts every issues folder of the library is kept as it must be: its files named and listed, each

FR-007checkpassing

The note of a requirement that is checked, in the table of enforcement, MUST be the tests that carry its tag (file: title, read from the tests), so that a note cannot name a test that is not there or that does not prove it; a note that is not so MUST be found, and the table MUST be writable from the tests.

Enforced (check): .github: cd commons/data && bun run verify — suite/enforcement-notes.test.ts: the notes of the table of enforcement are the tests that carry the requirement's tag, and a note that names a test that is not there or does not prove it is found

Proved by: data/suite/enforcement-notes.test.ts

Written in: data/tools/enforcement.ts

Tests: passed: suite/enforcement-notes.test.ts the notes of the table of enforcement are the tests that carry the requirement's tag, and

FR-008checkpassing

Every specification of the library MUST be in force and none Draft, so that the trace holds each requirement to a test that proves it or a reviewed reason; a Draft specification MUST be found.

Enforced (check): .github: cd commons/data && bun run verify — suite/enforcement-notes.test.ts: every specification of the library is in force, so the trace holds each requirement to a test

Proved by: data/suite/enforcement-notes.test.ts

Tests: passed: suite/enforcement-notes.test.ts every specification of the library is in force, so the trace holds each requirement to a t

Out of scope

  • The database copy of the issues: 0045-issues-model.
  • Fixing the issues themselves: each issue says what is to be done.

Edge cases

  • A folder of a model or an extension that is itself called issues: it is a unit and not a folder of issues, per FR-002.
  • A shallow clone cannot say whether a commit exists: the commit is then taken as given, per FR-006.
  • An issue that is wrong: it is closed as not a defect with its reason, never removed, per FR-004.

Assumptions

  • Issues are raised and closed by editing code in a commit, which is the record of who and when.

Open questions

OQ-1open question

Whether the git history of a set (the version before) should be read by the gate itself, which now holds a set only as it is.

Key entities

  • Issue - one known weakness, as a typed value.
  • Issue set - the issues of one scope, in order.

Success criteria

SC-001success criterion

A weakness known to the library cannot be dropped, left without its proof when called fixed, or charged to an engine that cannot be expected to have what is missing.

Review & acceptance checklist

  • [x] Every requirement is testable (MUST / MUST NOT), not aspirational
  • [x] No company fact is asserted here
  • [x] Every open item is marked, not silently decided

Cited by

governance/issue, Data, issues/mod, models/issues/mod, config, Planning, physical/sources/issues, Intellectual Frontiers Commons, Planning sources and the store, Planning, The issues model and its synchronisation

Titles, headings, exports, tables, columns and requirements. Esc closes.