8000 feat: bootstrap jikan's context-layer documents (backend-suite) by irfan-dahir · Pull Request #605 · jikan-me/jikan · GitHub
[go: up one dir, main page]

Skip to content

feat: bootstrap jikan's context-layer documents (backend-suite) - #605

Merged
irfan-dahir merged 1 commit into
feat/backend-suite-hardeningfrom
feat/backend-suite-context-docs
Oct 11, 2026
Merged

irfan-dahir merged 1 commit into
feat/backend-suite-hardeningfrom
feat/backend-suite-context-docs

Conversation

@irfan-dahir
Copy link
Copy Markdown
Collaborator

Stacked on #604. Completes the understand-existing-project chain's context-docs step — the last missing piece of the suite onboarding.

What this adds

Five role documents scaffolded as honest stubs (status: stub → resolve exits 5, counted as design debt until authored, never as coverage):

File Role Notes
CHANGELOG.md changelog format-contract template with DECIDE markers
CONTRIBUTING.md contributing jikan has 124 forks and no CONTRIBUTING.md — fills a real gap
DECISIONS.md decisions append-only decision log template
DEPRECATIONS.md deprecations running ledger — valuable for the breaking v4→v5 line
API-STANDARD.md api-standard pre-framed for a client library: jikan consumes MyAnimeList, so the standard governs jikan's own public API (MalClient / Request / Parser / Model / exception contract), linking the errorHandling arch-rules

Five app/org-shaped roles declined with written reasons (resolve exits 4): brief, backlog, builds, deployment, production-readiness — library-shaped N/A.

docs.manifest.json updated (roles + declinedRoles + _readme); survey.json refreshed (478 files, 0 couldNotDetermine).

What it unlocks

Preflight blocked: 14 → 9. Newly runnable: /audit-layer-boundaries (unblocked by the api-standard mapping), /bootstrap-api-docs, /upgrade-apply, /upgrade-measure, /quality-debt, /repo-health. The remaining 9 blocked need org/house-style roles (pr, plans, production-readiness, documentation-rules, …) jikan deliberately does not have as a client-facing library.

Points for reviewers

  • The five stubs are unwritten by design — the suite marks them as debt until each DECIDE section is answered. Authoring each (e.g. a real CHANGELOG for v4→v5) is the natural next step, out of scope here.
  • Deciding whether the api-standard shape is right for a library is worth a look — I pre-answered only the one knowable DECIDE (client vs backend); the rest need your conventions.

Complete the understand-existing-project chain's context-docs step: five
role documents scaffolded as honest stubs (status: stub, resolve exit 5,
counted as design debt until authored), five app/org-shaped roles declined
with written reasons, docs.manifest and survey.json updated.

New stubs (each carries the suite's DECIDE/DERIVED markers for a human to
answer):
- CHANGELOG.md        - changelog role
- CONTRIBUTING.md     - contributing role
- DECISIONS.md        - decisions role
- DEPRECATIONS.md     - deprecations role
- API-STANDARD.md     - api-standard role (pre-framed for a client library:
                         jikan consumes MyAnimeList; the standard governs
                         jikan's own public API surface)

Declined with a reason each (resolve exit 4): brief, backlog, builds,
deployment, production-readiness — library-shaped N/A.

Preflight blocked: 14 -> 9 (the audit-layer-boundaries skill is now
unblocked by the api-standard mapping; the remaining 9 need org/house-style
roles jikan does not have).

survey.json refreshed: 478 files, 0 couldNotDetermine.
@irfan-dahir
irfan-dahir merged commit c064902 into feat/backend-suite-hardening Oct 11, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

0