Skip to content

connector-api-changelog-entry: Grouping, brevity - #78

Open
jnv wants to merge 2 commits into
mainfrom
chore/improve-changelog-skill
Open

connector-api-changelog-entry: Grouping, brevity#78
jnv wants to merge 2 commits into
mainfrom
chore/improve-changelog-skill

Conversation

@jnv

@jnv jnv commented Aug 12, 2026

Copy link
Copy Markdown
Member

Summary

Adjust Claude skill to generate shorter changelog entries and more meaningful groups.

Checklist

  • Documentation follows the contribution guidelines
  • Changelog accurately describes all changes
  • All hyperlinks tested
  • SUMMARY.md updated if new pages added

API

  • Changelog highlights the affected endpoints or operations
  • Changelog highlights any deprecations
  • Deprecation Table updated if any deprecations

@jnv
jnv requested a review from a team as a code owner August 12, 2026 13:31
@moxly

moxly commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Review posted. View review · run

@moxly moxly left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

  1. In CONTRIBUTING.md (Updates block structure / heading rule sections, and .claude/skills/connector-api-changelog-entry/SKILL.md lines 76-77): reconcile the two docs. CONTRIBUTING.md still says "one {% update %} block per date" and shows a pure-date heading example (## 25th February 2026), while the updated SKILL.md now says several blocks may share a date and headings must never be date-only. Update CONTRIBUTING.md's wording/example to match the new convention (which is what the live changelog already does).
  2. 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").

Comment thread .claude/skills/connector-api-changelog-entry/SKILL.md
Comment thread .claude/skills/connector-api-changelog-entry/SKILL.md Outdated
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@jnv
jnv requested a review from moxly August 13, 2026 08:46
@moxly

moxly commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

Review posted. View review · run

@moxly moxly left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@jnv
jnv enabled auto-merge (squash) August 13, 2026 09:28
@jnv jnv self-assigned this Aug 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants