Phase 1: progressive-disclosure refactor — hmrc-api (804 → 188 lines) - #19
Merged
Conversation
Split the large Expertise block into 2 references/ files: api-oauth-fraud (endpoints, MTD timeline, OAuth 2.0, fraud-prevention headers) and self-assessment-error-config (Self Assessment integration, error handling, sandbox testing, configuration). Lean SKILL.md keeps trigger, context, doc lookup, standards, checklist, anti-patterns, external-ID management, sandbox-vs-prod. Real section boundaries; fences verified. No content lost.
There was a problem hiding this comment.
Pull request overview
Refactors the hmrc-api skill into a leaner SKILL.md that routes readers to on-demand deep-dive reference docs, reducing always-loaded content while preserving the detailed HMRC integration guidance.
Changes:
- Replaces the large inlined “Expertise” block in
SKILL.mdwith a short “Deep-dive references” pointer list. - Adds
references/api-oauth-fraud.mdto hold endpoints, OAuth 2.0 flow details, MTD timeline, and fraud-prevention header guidance. - Adds
references/self-assessment-error-config.mdto hold Self Assessment integration examples, error handling, sandbox testing, and configuration details.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
claude/skills/operations/govtech/hmrc-api/SKILL.md |
Removes the inlined deep expertise section and replaces it with links/pointers to reference docs. |
claude/skills/operations/govtech/hmrc-api/references/api-oauth-fraud.md |
New deep-dive reference for OAuth/endpoints/MTD timeline/fraud header requirements and examples. |
claude/skills/operations/govtech/hmrc-api/references/self-assessment-error-config.md |
New deep-dive reference for Self Assessment integration, error handling, sandbox testing, and configuration. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…nt-error-config.md Promote the top-level sections from H3 to H2 (and their H4 children to H3) so the reference goes H1 -> H2 -> H3, consistent with the other references.
olehsvyrydov
added a commit
that referenced
this pull request
Jun 6, 2026
…#19) * Phase 1: progressive-disclosure refactor of hmrc-api (804 -> 188 lines) Split the large Expertise block into 2 references/ files: api-oauth-fraud (endpoints, MTD timeline, OAuth 2.0, fraud-prevention headers) and self-assessment-error-config (Self Assessment integration, error handling, sandbox testing, configuration). Lean SKILL.md keeps trigger, context, doc lookup, standards, checklist, anti-patterns, external-ID management, sandbox-vs-prod. Real section boundaries; fences verified. No content lost. * Address Copilot review on PR #19: fix heading levels in self-assessment-error-config.md Promote the top-level sections from H3 to H2 (and their H4 children to H3) so the reference goes H1 -> H2 -> H3, consistent with the other references.
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.
What
Slice-4 refactor #14. Splits
hmrc-api(804 lines) into a leanSKILL.md(188 lines) + 2references/files (the ~620-line Expertise block):api-oauth-fraud.md— API endpoints, MTD timeline, OAuth 2.0 implementation, mandatory fraud-prevention headers.self-assessment-error-config.md— Self Assessment API integration, error handling, sandbox testing, configuration.Lean
SKILL.mdkeeps trigger, context, doc lookup, standards, checklist, anti-patterns, external-ID management, sandbox-vs-production differences.Why
Same pattern as #5–#18. No content lost (804 → 188 + 2 refs); real boundaries; fences verified balanced/non-nested.
Review focus
Content preservation; coherent lean router.