connector-api-changelog-entry: Grouping, brevity - #78
Conversation
|
✅ Review posted. View review · run |
moxly
left a comment
There was a problem hiding this comment.
Risk Assessment
Score: 1/10 — low
This is a documentation-tooling change (Claude skill instructions) with no application code risk; the main concern is that the updated skill guidance now diverges from CONTRIBUTING.md, which is the canonical style doc for human contributors.
Review Summary
Verdict: COMMENT
0 critical, 1 warning, 1 nit
The PR itself is sound – the new grouping/brevity rules match the real conventions already used in connector-api/changelog/README.md (topic-based headings, multiple same-date blocks, the "respectively" pattern for parallel operations, and the tag-balance grep check all check out against the live file). The one gap is that CONTRIBUTING.md, listed as this skill's primary source of truth, wasn't updated to match, so it now contradicts the new rules for the CS/TPS/partner contributors who read it directly instead of the skill.
Fix All — prompt for AI agent
Fix the following issues in this PR:
- In
CONTRIBUTING.md(Updates block structure / heading rule sections, and.claude/skills/connector-api-changelog-entry/SKILL.mdlines 76-77): reconcile the two docs.CONTRIBUTING.mdstill says "one{% update %}block per date" and shows a pure-date heading example (## 25th February 2026), while the updatedSKILL.mdnow says several blocks may share a date and headings must never be date-only. UpdateCONTRIBUTING.md's wording/example to match the new convention (which is what the live changelog already does). - In
.claude/skills/connector-api-changelog-entry/SKILL.md(line 79): change "neighbouring" to "neighboring" for spelling consistency with the rest of the repo (which uses American English, e.g. "behavior").
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
✅ Review posted. View review · run |
moxly
left a comment
There was a problem hiding this comment.
Review Summary
Verdict: APPROVE
Re-review scoped to commits since 2736063 — no new issues. Both previously flagged items are fixed: CONTRIBUTING.md now matches the SKILL.md convention (per-topic {% update %} blocks, non-date headings, the "respectively" pattern for parallel objects, and guidance not to restate reference-page content), and "neighbouring" was corrected to "neighboring" for spelling consistency.
Summary
Adjust Claude skill to generate shorter changelog entries and more meaningful groups.
Checklist
SUMMARY.mdupdated if new pages addedAPI