docs: keep changeset summaries to one line#48
Merged
Conversation
|
| 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]
Reviews (1): Last reviewed commit: "docs: keep changeset summaries to one li..." | Re-trigger Greptile
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.
Small contributor-guidance update: changeset summaries land in CHANGELOGs verbatim, so keep them to a single line whenever possible.