8000 docs: author CHANGELOG (v5.0.0) and CONTRIBUTING; log exemptions decision by irfan-dahir · Pull Request #607 · jikan-me/jikan · GitHub
[go: up one dir, main page]

Skip to content

docs: author CHANGELOG (v5.0.0) and CONTRIBUTING; log exemptions decision - #607

Merged
irfan-dahir merged 1 commit into
feat/display-sentinel-constantsfrom
docs/changelog-contributing
Oct 11, 2026
Merged

irfan-dahir merged 1 commit into
feat/display-sentinel-constantsfrom
docs/changelog-contributing

Conversation

@irfan-dahir
Copy link
Copy Markdown
Collaborator

Stacked on #606. Converts two context-layer stubs into authored documents and records the KEEP decision on the error-handling exemptions.

CHANGELOG.md — authored (stub removed)

Starts at the v5.0.0 line; entries before it are deliberately not reconstructed (the template's own rule against presenting a git-log guess as a record). The v5.0.0 entry is written from the measured v4→v5 diff, not prose:

  • Breaking: PHP floor raised to ^8.4; the abandoned fabpot/goutte HTTP stack replaced by symfony/browser-kit, css-selector, http-client.
  • Added: 11 new MalClient methods (getArticle*, getNews*, getRecent*, getPinnedArticles) with 11 new Jikan\Request\* value objects.
  • Changed: test layout (test/unit), PHPUnit/paratest/grumphp bumps, composer test script.
  • Verified claims: zero MalClient methods or Request classes removed; RequestInterface/ParserInterface byte-identical; Anime model public-API diff empty — the public surface is a strict superset.

Per the changelog's own "consumer-visible only" bar, internal work (fixture hermeticity, display-string constants, audit config) stays out — with the two internal decisions logged in DECISIONS.md instead.

CONTRIBUTING.md — authored (stub removed)

Real, verified toolchain: composer install + composer link-fixtures (required — tests never hit the live site), composer test, php-cs-fixer, the grumphp + backend-suite pre-commit gates, the end-to-end spine for adding one endpoint (Request → Parser → Model → MalClient → fixture test → docs), and how to wire the merged pre-commit hook on a fresh checkout.

DECISIONS.md — second entry

Records the KEEP decision (this review): the BadResponseException/ParserException intentionalDeadStates exemptions stay, with the reason (the audit's instanceof-consumption model is screen-shaped; a library's exceptions are consumed by catching).

Doc debt: 2-of-7 → 4-of-7 roles authored (resolve now exits 0 for changelog/contributing). Remaining stubs: api-standard, decisions (partially authored, still marked stub), deprecations. Committed through the merged pre-commit hook (suite gates + grumphp, both clean).

Two context-layer stubs become authored documents (resolve exit 0; doc debt
2-of-7 -> 4-of-7):

- CHANGELOG.md: starts at the v5.0.0 line (entries before it deliberately not
  reconstructed). v5.0.0 entry is written from the measured v4->v5 diff:
  PHP ^8.4 floor and the goutte->Symfony HTTP swap as the two breaking items;
  the public surface is a strict superset (11 new Article/News MalClient
  methods, 11 new Request classes; no methods, Request classes or interfaces
  removed; Anime model surface diff-empty). Format contract and severity
  rules answered as DECIDEs. Per the changelog's own bar, internal work
  (fixture handling, constants refactor, audit config) is deliberately
  absent.

- CONTRIBUTING.md: real toolchain (composer install + link-fixtures,
  composer test, php-cs-fixer, grumphp + backend-suite pre-commit gates),
  the end-to-end spine for adding one endpoint (Request -> Parser -> Model
  -> MalClient -> fixture test -> docs), the hermetic fixtures workflow, and
  how to wire the merged pre-commit hook on a fresh checkout.

- DECISIONS.md: second authored entry — record the decision to KEEP the
  BadResponseException/ParserException dead-state exemptions in
  exceptions.json (screen-shaped instanceof-consumption model does not
  describe how a library's exceptions are consumed).

Committed through the merged pre-commit hook (suite gates + grumphp).
@irfan-dahir
irfan-dahir merged commit 19f419c into feat/display-sentinel-constants Oct 11, 2026
3 checks passed
CrafterSama pushed a commit to CrafterSama/jikan that referenced this pull request Oct 27, 2026
6-PR review fixes: docs.manifest.json._readme still described api-standard,
changelog, contributing, decisions and deprecations as unwritten stubs
(resolve exit 5); they have all been authored (jikan-me#607/jikan-me#608). Now states all
seven mapped roles are authored and five are declined. survey.json (derived)
re-run so its source stamp and census reflect the current tree.

Whole-stack review status at HEAD: repo-health 8 clean / 0 findings / 11
honest refusals; quality-debt all-A; composer test 394/394.
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