Skip to content
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

Add links to all issues in the 3.2.3, 3.2.1 and 3.2.0 sections of the changelog #378

Merged

Conversation

rodrigoprimo
Copy link
Contributor

Description

This PR adds links to all issues in the 3.2.3, 3.2.1, and 3.2.0 sections of the changelog. There were no links in the 3.2.2 section of the changelog. Two typos were fixed.

Versions 3.2.1 and 3.2.0 contained references to GitHub links outside of the Fixed section and I added links for those. Highlighting this in case I should not have added those links for whatever reason.

On a somewhat related note, I wonder if it was ever considered to add links to the GitHub issue/PR for all the changelog entries (when appropriate) and not only for bug fixes? I mean this for future versions of PHPCS. I personally find that it can be useful in some circumstances to have links to the discussion that originated a new feature for example.

Related issues/external references

Part of #244

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
    • This change is only breaking for integrators, not for external standards or end-users.
  • Documentation improvement

PR checklist

  • I have checked there is no other PR open for the same change.
  • I have read the Contribution Guidelines.
  • I grant the project the right to include and distribute the code under the BSD-3-Clause license (and I have the right to grant these rights).
  • I have added tests to cover my changes.
  • I have verified that the code complies with the projects coding standards.
  • [Required for new sniffs] I have added XML documentation for the sniff.

@jrfnl
Copy link
Member

jrfnl commented Mar 4, 2024

Versions 3.2.1 and 3.2.0 contained references to GitHub links outside of the Fixed section and I added links for those. Highlighting this in case I should not have added those links for whatever reason.

That's exactly as per my intention in #244. 👍🏻

On a somewhat related note, I wonder if it was ever considered to add links to the GitHub issue/PR for all the changelog entries (when appropriate) and not only for bug fixes? I mean this for future versions of PHPCS. I personally find that it can be useful in some circumstances to have links to the discussion that originated a new feature for example.

I totally agree that can be useful, so, if you look at the more recent changelogs (3.8.1, 3.9.0), you will see the issue/PR number referenced a lot more often, not just in the "Fixed" section.
I didn't rewrite the changelog for 3.8.0 as I wanted to get that release tagged as soon as I could after taking over (and the changelog was largely already written up in the package.xml file which previously contained the entries).

Before that time, I wasn't directly involved in preparing the changelog and I don't think we need to rewrite history, but yes, going forward, whenever I believe it is useful for people to be able to quickly click through to the underlying info, I am adding and will continue to add issue/pull request references,

@jrfnl
Copy link
Member

jrfnl commented Mar 4, 2024

Oh and the changelog is now pulled ~ a day or so before each release (instead of directly committed to the main branch after each merge/commit), so if you think a reference link is missing somewhere while it would have value, please leave a comment on the PR.

CHANGELOG.md Outdated Show resolved Hide resolved
@jrfnl jrfnl force-pushed the changelog-improvements-3-2-x branch from c6aef53 to b8ebef8 Compare March 5, 2024 09:11
@jrfnl jrfnl enabled auto-merge March 5, 2024 09:11
@jrfnl jrfnl merged commit 811f138 into PHPCSStandards:master Mar 5, 2024
38 checks passed
@rodrigoprimo rodrigoprimo deleted the changelog-improvements-3-2-x branch March 5, 2024 12:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants