docs(contributing): DARC/SKEEP onboarding, issue taxonomy, F1Score worked example - #1238
Merged
Merged
Conversation
…rked example Make the two contribution processes discoverable and decomposable: - New Antora pages: contributing/getting-started (DARC vs SKEEP side by side, the decision rule, lanes, how to find and claim a task), contributing/issue-taxonomy (labels, title prefixes, templates, gh commands), contributing/darc-worked-example-f1score (#1222 and its sub-issues, incl. the SKEEP-005 hand-over for ground-truth metrics). - darc-workflow: add "DARC and SKEEP" and lane-decomposition sections; SKEEP index: add "SKEEP and DARC", procedure pointer, status-upkeep note, tracking-issue field; register missing SKEEP-004 nav entry. - CONTRIBUTING.md / README.md: DARC+SKEEP summary, first-timer links, good-first-issue searches, SKEEP tracking-issue step. - Issue taxonomy as source: .github/labels.txt + sync-labels.sh (skill:*, size:*, darc, skeep on top of the existing tracking / sub-issue / phase labels); templates darc_lane_task.md and skeep_tracking.md; issue chooser config with docs links. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01V4zaUvssQnWmKTMawtqKtX
michalharakal
added
the
documentation
|
📖 Documentation Preview The documentation has been built successfully for this PR. Generated Files:
Artifacts:
This comment will be updated automatically when the PR is updated. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Makes SKaiNET's two contribution processes — DARC (per-feature: Document / Assess / Research / Code) and SKEEP (per-architectural-decision) — discoverable from one place, and gives DARC features a standard way to be decomposed into skill-labelled, independently claimable sub-issues.
Docs (Antora)
contributing/getting-started.adoc— DARC vs SKEEP side by side, the "DARC or SKEEP?" decision rule with concrete calls, the six lanes (+ Lane 0 SKEEP), how to find and claim a first task, first-PR checklist.contributing/issue-taxonomy.adoc— every label, title prefix, template;ghcommands to decompose a feature; label sync.contributing/darc-worked-example-f1score.adoc— [Feature]: Precision, Recall and F1Score metrics #1222 and its sub-issues walked through all four phases, including where the ground-truth harness gap hands over to SKEEP-005 ([SKEEP-005]: Ground-truth validation for stateful metrics #1223).darc-workflow.adoc: "DARC and SKEEP" + lane-decomposition sections; "Where DARC lives" table extended.index.adoc: "SKEEP and DARC", procedure pointer, tracking-issue field in the template, status-upkeep warning (SKEEP-002 still says Draft though it shipped). Also registers the missing SKEEP-004 nav entry.contributing/index.adoc, rootindex.adoc,nav.adocwired up.Repo-root
CONTRIBUTING.md: DARC/SKEEP table, "Finding work" taxonomy summary, SKEEP tracking-issue step.README.md: first-timer links (getting started · good-first-issue searches by skill/size · taxonomy) and a DARC+SKEEP summary where before only SKEEP was mentioned.Issue tooling (
.github/)labels.txt(source of truth) +scripts/sync-labels.sh(idempotent, never deletes). Addsskill:*,size:*,darc,skeepon top of the existingtracking/sub-issue/assessment/research/codinglabels. Already applied to this repo.darc_lane_task.md(sub-issue) andskeep_tracking.md;config.ymllinks the chooser to the docs.Already live on GitHub (this PR documents it)
good first issue), SKEEP-005 tracking issue [SKEEP-005]: Ground-truth validation for stateful metrics #1223.ML - good first issuelabel retired.Validation
SKaiNET-compiler.svginreference/architecture.adoc, is pre-existing).DRY_RUN=1 .github/scripts/sync-labels.shand a real run against this repo.Docs/tooling only — no Kotlin changes.
🤖 Generated with Claude Code
https://claude.ai/code/session_01V4zaUvssQnWmKTMawtqKtX