Skip to content

docs: keep changeset summaries to one line#48

Merged
mgabor3141 merged 1 commit into
mainfrom
docs-changeset-one-liner
May 2, 2026
Merged

docs: keep changeset summaries to one line#48
mgabor3141 merged 1 commit into
mainfrom
docs-changeset-one-liner

Conversation

@mgabor3141
Copy link
Copy Markdown
Owner

Small contributor-guidance update: changeset summaries land in CHANGELOGs verbatim, so keep them to a single line whenever possible.

@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented May 2, 2026

Greptile Summary

This PR adds a brief note to AGENTS.md asking contributors to keep changeset summaries to a single line, since they appear verbatim in the CHANGELOG. The change is documentation-only and introduces no code or behavioral modifications.

Confidence Score: 5/5

Safe to merge — documentation-only change with no code impact.

Single-line prose addition to a contributor guide. No logic, no runtime code, no schema changes.

No files require special attention.

Important Files Changed

Filename Overview
AGENTS.md Single-sentence addition to the changeset guidance, instructing contributors to keep summaries to one line for CHANGELOG readability.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Contributor makes changes] --> B[Run yarn changeset]
    B --> C{Write summary}
    C -->|Single line ✅| D[Summary appears cleanly in CHANGELOG]
    C -->|Multi-line ⚠️| E[CHANGELOG entry becomes unwieldy]
Loading

Reviews (1): Last reviewed commit: "docs: keep changeset summaries to one li..." | Re-trigger Greptile

@mgabor3141 mgabor3141 merged commit 0d3d73c into main May 2, 2026
1 check passed
@mgabor3141 mgabor3141 deleted the docs-changeset-one-liner branch May 2, 2026 10:39
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