IF Commons GitHub

issue

concept

One known weakness of a library or a module, as the code of the repository says it

Model issues. Written in commons/data/models/issues/mod.ts:75. Identified by issueId.

Governance: attributes

appliesToAllbooleanrequired

Whether it is about every engine; where not, the engines are listed

Becomes the column applies_to_all of issue.

Written at commons/data/models/issues/mod.ts:91

contentHashtextrequired

A hash of what the code says of it, so that a change is seen

Becomes the column content_hash of issue.

Written at commons/data/models/issues/mod.ts:93

duplicateOfintegeroptional

The number of the issue it duplicates

Becomes the column duplicate_of of issue.

Written at commons/data/models/issues/mod.ts:90

issueIdidentifierrequired

What identifies the issue: its scope and number

Becomes the column issue_id of issue.

Written at commons/data/models/issues/mod.ts:78

numberintegerrequired

Its number within the scope

Becomes the column number of issue.

Written at commons/data/models/issues/mod.ts:80

presencecode of issuePresencerequired

Whether the code still has it

Becomes the column presence of issue.

Written at commons/data/models/issues/mod.ts:94

prioritycode of issuePriorityrequired

When it is to be done

Becomes the column priority of issue.

Written at commons/data/models/issues/mod.ts:85

raisedtextrequired

The day it was raised

Becomes the column raised of issue.

Written at commons/data/models/issues/mod.ts:92

scopetextrequired

The library or module it is of, by its path

Becomes the column scope of issue.

Written at commons/data/models/issues/mod.ts:79

severitycode of issueSeverityrequired

How bad it is

Becomes the column severity of issue.

Written at commons/data/models/issues/mod.ts:84

sizecode of issueSizerequired

How much work the fix is

Becomes the column size of issue.

Written at commons/data/models/issues/mod.ts:86

slugtextrequired

Its name in words joined by hyphens

Becomes the column slug of issue.

Written at commons/data/models/issues/mod.ts:81

statusKindcode of issueStatusKindrequired

Where it is

Becomes the column status_kind of issue.

Written at commons/data/models/issues/mod.ts:87

statusProoftextoptional

What shows it is done, for one that is fixed

Becomes the column status_proof of issue.

Written at commons/data/models/issues/mod.ts:89

statusReasontextoptional

Why, for a status that needs a reason

Becomes the column status_reason of issue.

Written at commons/data/models/issues/mod.ts:88

summarytextrequired

What is wrong and why it matters

Becomes the column summary of issue.

Written at commons/data/models/issues/mod.ts:83

syncedAtinstantrequired

When a synchronisation last wrote it

Becomes the column synced_at of issue.

Written at commons/data/models/issues/mod.ts:95

titletextrequired

What it is, in a line

Becomes the column title of issue.

Written at commons/data/models/issues/mod.ts:82

Logical: the table

Projects to the table issue with the primary key issue_id.

ColumnTypeNullRoleFrom
applies_to_allbooleanfalseattributeissue.appliesToAll
content_hashtextfalseattributeissue.contentHash
duplicate_ofintegertrueattributeissue.duplicateOf
issue_idtextfalseattributeissue.issueId
numberintegerfalseattributeissue.number
presencetextfalseattributeissue.presence
prioritytextfalseattributeissue.priority
raisedtextfalseattributeissue.raised
scopetextfalseattributeissue.scope
severitytextfalseattributeissue.severity
sizetextfalseattributeissue.size
slugtextfalseattributeissue.slug
status_kindtextfalseattributeissue.statusKind
status_prooftexttrueattributeissue.statusProof
status_reasontexttrueattributeissue.statusReason
summarytextfalseattributeissue.summary
synced_attimestampfalseattributeissue.syncedAt
titletextfalseattributeissue.title

Physical: SQL

CREATE TABLE IF NOT EXISTS "issue" (
    "issue_id" VARCHAR NOT NULL PRIMARY KEY,
    "scope" VARCHAR NOT NULL,
    "number" INTEGER NOT NULL,
    "slug" VARCHAR NOT NULL,
    "title" VARCHAR NOT NULL,
    "summary" VARCHAR NOT NULL,
    "severity" VARCHAR NOT NULL,
    "priority" VARCHAR NOT NULL,
    "size" VARCHAR NOT NULL,
    "status_kind" VARCHAR NOT NULL,
    "status_reason" VARCHAR,
    "status_proof" VARCHAR,
    "duplicate_of" INTEGER,
    "applies_to_all" BOOLEAN NOT NULL,
    "raised" VARCHAR NOT NULL,
    "content_hash" VARCHAR NOT NULL,
    "presence" VARCHAR NOT NULL,
    "synced_at" TIMESTAMPTZ NOT NULL,
    CONSTRAINT "issue_scope_number_uq" UNIQUE ("scope", "number"),
    CONSTRAINT "issue_severity_ck" CHECK ("severity" IN ('critical', 'high', 'medium', 'low')),
    CONSTRAINT "issue_priority_ck" CHECK ("priority" IN ('p_1', 'p_2', 'p_3')),
    CONSTRAINT "issue_size_ck" CHECK ("size" IN ('xs', 's', 'm', 'l', 'xl')),
    CONSTRAINT "issue_status_kind_ck" CHECK ("status_kind" IN ('open', 'in_progress', 'fixed', 'wont_fix', 'not_a_defect', 'duplicate', 'deferred')),
    CONSTRAINT "issue_presence_ck" CHECK ("presence" IN ('present', 'withdrawn'))
);

Physical: the typed table

Read and written from TypeScript with the types the model gives: import { issue } from "@intellectual-frontiers/data/sql/typed/models". Generated in commons/data/sql/typed/models/issues.auto.ts: do not edit.

import { from } from "@intellectual-frontiers/data/sql/typed";
import { issue } from "@intellectual-frontiers/data/sql/typed/models";

const rows = await from(issue).select((s) => ({ issueId: s.issue.issueId, scope: s.issue.scope })).run(runner);

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