-
Notifications
You must be signed in to change notification settings - Fork 173
Add changelog & credits, update release notes #696
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
kasparsd
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great @jeffpaul, thanks for working on it! Had a few questions inline.
I know you have a lot of experience with the release workflows across many similar projects so I really appreciate your lead here!
|
Note that along with @kasparsd review comments above that I'll update the PR with the latest release as well https://github.com/WordPress/two-factor/releases/tag/0.14.0 |
|
@jeffpaul looks like a nice structure, do you think you could finalize this PR so its possible to merge it? |
|
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: @PluginVulnerabilities. Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases. 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. |
|
@masteradhoc the changes here should now resolve @kasparsd concerns and be current with recent releases |
masteradhoc
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
kasparsd
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great!
@jeffpaul Do you have suggestions for how to automate this? For example, how did you generate the contributor list, or those links in the footer of the changelog?
What?
This pull request introduces documentation updates to improve clarity and accessibility for contributors and users. Key changes include the addition of a comprehensive changelog, a dedicated credits file, and enhancements to release and security documentation.
Documentation Updates:
Changelog:
CHANGELOG.mdfile to document all notable changes in the project, adhering to the Keep a Changelog standard and Semantic Versioning. This provides a detailed history of updates, fixes, and features across versions.readme.txtto include a summary of recent changes and a link to the full changelog for complete details.Credits:
CREDITS.mdfile listing maintainers, contributors, and libraries utilized in the project. This acknowledges the efforts of all individuals involved and improves transparency.readme.mdto link to the newCREDITS.mdfile for contributor recognition.Release Process:
RELEASING.mdwith additional instructions for plugin committers, ensuring smoother release management and clarifying the committer requirements on wp.org.Why?
Resolves the remaining, outstanding items in #544.
How?
Testing Instructions
Screenshots or screencast
Changelog Entry