Add changelog & credits, update release notes #696

jeffpaul · 2025-07-03T03:07:20Z

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:

Added a new CHANGELOG.md file 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.
Updated readme.txt to include a summary of recent changes and a link to the full changelog for complete details.

Credits:

Introduced a new CREDITS.md file listing maintainers, contributors, and libraries utilized in the project. This acknowledges the efforts of all individuals involved and improves transparency.
Updated readme.md to link to the new CREDITS.md file for contributor recognition.

Release Process:

Enhanced RELEASING.md with 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

Changed - Updated documentation.

kasparsd

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!

kasparsd · 2025-07-03T06:33:14Z

CHANGELOG.md

+- Add developer tools for deploying to WP.org manually.
+
+[Unreleased]: https://github.com/WordPress/two-factor/compare/master...develop
+[0.13.0]: https://github.com/WordPress/two-factor/compare/0.12.0...0.13.0


Oh, wow. I didn't know markdown supported footer links like that. I wonder if this should be included in the release instructions because people might not realize that those headings are expecting a link.

Alternatively, could we inline the link with the heading? It is more verbose but makes it clear that the expectation is to include the link there.

You tell me, do you want it in the footer or each release header? Happy to adjust in either direction and add to the RELEASING.md accordingly.

I'd prefer to have it inline with each version heading. That makes it an obvious requirement.

kasparsd · 2025-07-03T06:37:12Z

CREDITS.md

+
+Thank you to all the people who have already contributed to this repository via bug reports, code, design, ideas, project management, translation, testing, etc.
+
+[853 (@Sonic853)](https://github.com/Sonic853), [Aaron Campbell (@aaroncampbell)](https://github.com/aaroncampbell), [Alexandru Apostol (@aapost0l)](https://github.com/aapost0l), [Ali Husnain (@alihusnainarshad)](https://github.com/alihusnainarshad), [Anton Vanyukov (@av3nger)](https://github.com/av3nger), [Arslan Kalwar (@akkspros)](https://github.com/akkspros), [Axel Simon (@axelsimon)](https://github.com/axelsimon), [Birgit Pauli-Haack (@bph)](https://github.com/bph), [Brooke. (@BrookeDot)](https://github.com/BrookeDot), [Calvin Alkan (@calvinalkan)](https://github.com/calvinalkan), [Carlos Faria (@cfaria)](https://github.com/cfaria), [Christian Chung (@christianc1)](https://github.com/christianc1), [Clayton Collie (@claytoncollie)](https://github.com/claytoncollie), [Connor Jennings (@cojennin)](https://github.com/cojennin), [Derek Herman (@valendesigns)](https://github.com/valendesigns), [Dion Hulse (@dd32)](https://github.com/dd32), [fossyatra (@netweb)](https://github.com/netweb), [Jeffrey Paul (@jeffpaul)](https://github.com/jeffpaul), [John Blackbourn (@johnbillion)](https://github.com/johnbillion), [John James Jacoby (@JJJ)](https://github.com/JJJ), [Josh Betz (@joshbetz)](https://github.com/joshbetz), [Kurt Zenisek (@KZeni)](https://github.com/KZeni), [Ian Dunn (@iandunn)](https://github.com/iandunn), [Mario Hoyos (@squaredpx)](https://github.com/squaredpx), [Mathesh (@Mati02K)](https://github.com/Mati02K), [Mehul Gohil (@mehul0810)](https://github.com/mehul0810), [Nauris Pūķis (@pyronaur)](https://github.com/pyronaur), [Neil Batchelor (@nbwpuk)](https://github.com/nbwpuk), [Ole Melhus (@omelhus)](https://github.com/omelhus), [Pascal Birchler (@swissspidy)](https://github.com/swissspidy), [Paul Kevan (@pkevan)](https://github.com/pkevan), [Paul Schreiber (@paulschreiber)](https://github.com/paulschreiber), [r-a-y (@r-a-y)](https://github.com/r-a-y), [Sergey Jinks (@sjinks)](https://github.com/sjinks), [sgrant (@sgrant)](https://github.com/sgrant), [Shai Sapphire (@shay1383)](https://github.com/shay1383), [Spenser Hale (@spenserhale)](https://github.com/spenserhale), [Stefan Momm (@stefanmomm)](https://github.com/stefanmomm), [Steve Grunwell (@stevegrunwell)](https://github.com/stevegrunwell), [Steven Word (@stevenkword)](https://github.com/stevenkword), [Thrijith Thankachan (@thrijith)](https://github.com/thrijith), [Tomasz Dziuda (@dziudek)](https://github.com/dziudek), [Toni Viemerö (@todeveni)](https://github.com/todeveni), [Viktor Szépe (@szepeviktor)](https://github.com/szepeviktor).


Did you generate this list somehow? Should we include it in the release instructions? Are we including every contributor here?

I did a quick scan of folks that were called out, noting there are a couple I just found that I need to add. Definitely needs to be added to RELEASING.md so that's not left off.

Are you ok with the alpha order here? Do you want me to split into sub-sections (e.g. ### A-G, ### H-M, etc)?

No preference. Whatever you suggest.

kasparsd · 2025-07-03T06:38:42Z

readme.txt

 == Changelog ==

-See the [release history](https://github.com/wordpress/two-factor/releases).
+= 0.13.0 - 2025-04-02 =


What's the expectation around this changelog and the CHANGELOG.md? Do we keep them in sync manually?

My thinking was we keep the last X releases in the readme so there's some content there but maintain the full listing on GH in the CHANGELOG.md file. I can update RELEASING.md to note that distinction.

Sounds good. We can probably implement some release magic that extracts the top items from the CHANGELOG file and places them here. That way we only need to update in a single location.

kasparsd · 2025-07-03T06:39:38Z

readme.txt

+- Update automated testing to cover PHP 8.4 and default to PHP 8.3 by @BrookeDot in #665
+
+= 0.12.0 - 2025-02-14 =
+- Simplify the Two Factor settings in user profile by @kasparsd in #654


On GitHub the author and pull request number would get linked automatically. I wonder if we should do that here too. Having that data without the links really doesn't help users to quickly see what is included.

Yeah, we do that over on 10up projects, happy to do so here as well. Will update accordingly.

jeffpaul · 2025-07-08T19:22:04Z

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

masteradhoc · 2026-02-01T11:02:13Z

@jeffpaul looks like a nice structure, do you think you could finalize this PR so its possible to merge it?

github-actions · 2026-02-01T11:02:21Z

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 props-bot label.

Unlinked Accounts

The 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.

Unlinked contributors: PluginVulnerabilities.

Co-authored-by: jeffpaul <jeffpaul@git.wordpress.org>
Co-authored-by: kasparsd <kasparsd@git.wordpress.org>
Co-authored-by: masteradhoc <masteradhoc@git.wordpress.org>
Co-authored-by: iandunn <iandunn@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

jeffpaul added 6 commits July 2, 2025 21:39

Create CHANGELOG.md

642ca35

add recent changelog, historical link, and upgrade notices to readme

7652e13

add changelog link to readme

c7a7990

Create CREDITS.md

9a0d339

update credits link in readme

9335d2d

Update RELEASING.md

08dbd9f

jeffpaul added this to the 0.14.0 milestone Jul 3, 2025

jeffpaul requested a review from kasparsd July 3, 2025 03:07

jeffpaul self-assigned this Jul 3, 2025

jeffpaul linked an issue Jul 3, 2025 that may be closed by this pull request

Repo/process updates #544

Open

kasparsd approved these changes Jul 3, 2025

View reviewed changes

Update CREDITS.md

00d2617

jeffpaul modified the milestones: 0.14.0, 0.15.0 Jul 3, 2025

jeffpaul modified the milestones: 0.14.2, 0.15.0 Dec 11, 2025


		Thank you to all the people who have already contributed to this repository via bug reports, code, design, ideas, project management, translation, testing, etc.

		[853 (@Sonic853)](https://github.com/Sonic853), [Aaron Campbell (@aaroncampbell)](https://github.com/aaroncampbell), [Alexandru Apostol (@aapost0l)](https://github.com/aapost0l), [Ali Husnain (@alihusnainarshad)](https://github.com/alihusnainarshad), [Anton Vanyukov (@av3nger)](https://github.com/av3nger), [Arslan Kalwar (@akkspros)](https://github.com/akkspros), [Axel Simon (@axelsimon)](https://github.com/axelsimon), [Birgit Pauli-Haack (@bph)](https://github.com/bph), [Brooke. (@BrookeDot)](https://github.com/BrookeDot), [Calvin Alkan (@calvinalkan)](https://github.com/calvinalkan), [Carlos Faria (@cfaria)](https://github.com/cfaria), [Christian Chung (@christianc1)](https://github.com/christianc1), [Clayton Collie (@claytoncollie)](https://github.com/claytoncollie), [Connor Jennings (@cojennin)](https://github.com/cojennin), [Derek Herman (@valendesigns)](https://github.com/valendesigns), [Dion Hulse (@dd32)](https://github.com/dd32), [fossyatra (@netweb)](https://github.com/netweb), [Jeffrey Paul (@jeffpaul)](https://github.com/jeffpaul), [John Blackbourn (@johnbillion)](https://github.com/johnbillion), [John James Jacoby (@JJJ)](https://github.com/JJJ), [Josh Betz (@joshbetz)](https://github.com/joshbetz), [Kurt Zenisek (@KZeni)](https://github.com/KZeni), [Ian Dunn (@iandunn)](https://github.com/iandunn), [Mario Hoyos (@squaredpx)](https://github.com/squaredpx), [Mathesh (@Mati02K)](https://github.com/Mati02K), [Mehul Gohil (@mehul0810)](https://github.com/mehul0810), [Nauris Pūķis (@pyronaur)](https://github.com/pyronaur), [Neil Batchelor (@nbwpuk)](https://github.com/nbwpuk), [Ole Melhus (@omelhus)](https://github.com/omelhus), [Pascal Birchler (@swissspidy)](https://github.com/swissspidy), [Paul Kevan (@pkevan)](https://github.com/pkevan), [Paul Schreiber (@paulschreiber)](https://github.com/paulschreiber), [r-a-y (@r-a-y)](https://github.com/r-a-y), [Sergey Jinks (@sjinks)](https://github.com/sjinks), [sgrant (@sgrant)](https://github.com/sgrant), [Shai Sapphire (@shay1383)](https://github.com/shay1383), [Spenser Hale (@spenserhale)](https://github.com/spenserhale), [Stefan Momm (@stefanmomm)](https://github.com/stefanmomm), [Steve Grunwell (@stevegrunwell)](https://github.com/stevegrunwell), [Steven Word (@stevenkword)](https://github.com/stevenkword), [Thrijith Thankachan (@thrijith)](https://github.com/thrijith), [Tomasz Dziuda (@dziudek)](https://github.com/dziudek), [Toni Viemerö (@todeveni)](https://github.com/todeveni), [Viktor Szépe (@szepeviktor)](https://github.com/szepeviktor).

Add changelog & credits, update release notes #696

Are you sure you want to change the base?

Add changelog & credits, update release notes #696

Conversation

jeffpaul commented Jul 3, 2025

What?

Documentation Updates:

Changelog:

Credits:

Release Process:

Why?

How?

Testing Instructions

Screenshots or screencast

Changelog Entry

Uh oh!

kasparsd left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jeffpaul commented Jul 8, 2025

Uh oh!

masteradhoc commented Feb 1, 2026

Uh oh!

github-actions bot commented Feb 1, 2026

Unlinked Accounts

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants