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 2.2.0, 2.1.0, and 2.0.0 sections of the changelog #409

Merged

Conversation

rodrigoprimo
Copy link
Contributor

@rodrigoprimo rodrigoprimo commented Mar 19, 2024

Description

This PR adds links to all issues in the 2.2.0, 2.1.0, and 2.0.0 sections of the changelog

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.

Copy link
Member

@jrfnl jrfnl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @rodrigoprimo, while reviewing I noticed a couple of links which weren't working properly. This is not your fault, but we've now reached overlapping issue/PR number territory.

Sorry, I hadn't provided proper guidelines for this previously.

Links in the lists have to be unique and there are now a number of links which are no longer unique and have multiple link definitions, like [#335], which is defined in the link list for the 3.9.0 release to point to this repo and in the link list for the 2.1.0 release to point to the Squizlabs repo,

I think we need to change the links to the old repo to have a prefix and the same for the PEAR links (though it will be quite a while before there would be an overlap with those numbers) to prevent creating conflicting link definitions.

I've just opened up PR #410 to action this. I'd like to ask you to review my PR and once that PR has been merged, to update this PR to follow the same link pattern.

@rodrigoprimo
Copy link
Contributor Author

Sorry, I hadn't provided proper guidelines for this previously.

No worries and thanks for working on #410.

Links in the lists have to be unique and there are now a number of links which are no longer unique and have multiple link definitions, like [#335], which is defined in the link list for the 3.9.0 release to point to this repo and in the link list for the 2.1.0 release to point to the Squizlabs repo.

Good catch! I missed this.

I've just opened up PR #410 to action this. I'd like to ask you to review my PR and once that PR has been merged, to update this PR to follow the same link pattern.

Sure

@jrfnl
Copy link
Member

jrfnl commented Mar 20, 2024

PR #410 has been merged.

@rodrigoprimo rodrigoprimo changed the title Add links to all issues in the 2.2.0 and 2.1.0 sections of the changelog Add links to all issues in the 2.2.0, 2.1.0, and 2.0.0 sections of the changelog Mar 20, 2024
@rodrigoprimo
Copy link
Contributor Author

Thanks! I just pushed a new commit updating the links.

I also updated the title and the description of this PR as I noticed I forgot to point out that this PR also changes the changelog for version 2.0.0. I wasn't sure if I should update the original commit message as well or not since you already started reviewing this PR. Could you please update the commit message to include 2.0.0 when you squash the commits before merging the PR?

Copy link
Member

@jrfnl jrfnl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@jrfnl jrfnl added this to the 3.9.1 milestone Mar 26, 2024
@jrfnl jrfnl merged commit a965341 into PHPCSStandards:master Mar 26, 2024
38 checks passed
@rodrigoprimo rodrigoprimo deleted the changelog-improvements-2-1-0 branch March 26, 2024 14:05
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