Repository navigation
Conversation
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Warning: Type of PR label mismatch To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.
Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task. |
b015000 to
0a7fb3b
Compare
|
Size Change: 0 B Total Size: 7.76 MB |
|
"all changes" vs "external changes" is something that we've discussed before with the rest of the @WordPress/gutenberg-components crew, let's make sure we're all aligned here |
|
Also cc @ellatrix |
| ### Key Directories | ||
|
|
||
| - `/packages/` - JavaScript packages (each has README.md and CHANGELOG.md) | ||
| - `/packages/` - JavaScript packages (each has a `README.md` and `CHANGELOG.md`). Production package changes that affect external consumers require an entry in that package’s `CHANGELOG.md`. Consumer-visible changes include public API additions, removals, or behavior changes; changes observable through supported components or APIs; compatibility fixes; and changes to published package output. Do not add entries for tests, refactors, private APIs, or other internal implementation changes that have no effect on package consumers. |
There was a problem hiding this comment.
Since this affects how an agent should behave in /packages/ folder, I think the guidance could live in /packages/AGENTS.md so as not to bloat context for work it does outside that directory?
|
I don't really have strong feelings about this and am happy to go either way. The way I think about each perspective:
|
|
Closing this as I prefer that we do have more changelogs! |
What?
Clarifies the need for CHANGELOG entries in new PRs.
Why?
When reviewing PRs with an agent, it keeps flagging missing CHANGELOG updates, but we don't always require them, only if the changes are external facing.
How?
Updates to the docs.
Testing Instructions
Read the documentation and confirm you agree with it!