docs: clarify changelog is maintained by hand - #536
Open
faisalahammad wants to merge 1 commit into
Open
Conversation
The Changelog section of the release guide described the entry format but never said the changelog is written by hand and is not produced by an automated tool. Add a short note stating that the changelog lives in readme.txt, is maintained by a maintainer before each release, and that the milestone workflow only gathers merged PRs, it does not write the changelog text. Closes WordPress#497
|
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 Unlinked AccountsThe following contributors have not linked their GitHub and WordPress.org accounts: @tapheret2. Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases. Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
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
1 participant
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.
Clarify the changelog is maintained by hand and not generated by an automated tool.
The Changelog section of the release guide described the entry format (
== Changelog ==inreadme.txt) but never stated how the changelog is actually maintained. Contributions to the repo keep asking how the changelog updates automatically, and there is noCHANGELOG.mdor release automation publishing text to it.This adds a short note to
docs/contributing/releases.mdstating:readme.txtand is written by hand by a maintainer before each release.Closes #497