Repository navigation
docs: author CHANGELOG (v5.0.0) and CONTRIBUTING; log exemptions decision - #607
Merged
irfan-dahir merged 1 commit intoOct 11, 2026
Merged
Conversation
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).
This was referenced Oct 11, 2026
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.
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
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.
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:
fabpot/goutteHTTP stack replaced bysymfony/browser-kit,css-selector,http-client.MalClientmethods (getArticle*,getNews*,getRecent*,getPinnedArticles) with 11 newJikan\Request\*value objects.test/unit), PHPUnit/paratest/grumphp bumps,composer testscript.RequestInterface/ParserInterfacebyte-identical;Animemodel 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.mdinstead.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/ParserExceptionintentionalDeadStatesexemptions stay, with the reason (the audit'sinstanceof-consumption model is screen-shaped; a library's exceptions are consumed by catching).Doc debt: 2-of-7 → 4-of-7 roles authored (
resolvenow 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).