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

Link to PR in change log rather than issue #990

Open
corneliusroemer opened this issue Oct 15, 2024 · 3 comments
Open

Link to PR in change log rather than issue #990

corneliusroemer opened this issue Oct 15, 2024 · 3 comments

Comments

@corneliusroemer
Copy link
Contributor

corneliusroemer commented Oct 15, 2024

In the most recent release, the change log referenced an issue that had an outdated description, but the PR with up to date description was not referenced.

This is the issue: #976 and this the PR: #980

The issue mentions reserved chars than the PR introduces.

It might be good to link to both issue and PR to prevent confusion and make it easier to find relevant information.

Update: upon further reflection, it's the PR that matters most, issue is not necessary and can be easily found from PR.

@fengelniederhammer
Copy link
Contributor

The issue references the PR, so I actually don't think that we need to reference both in the changelog.

@corneliusroemer
Copy link
Contributor Author

There are about 10 backlinks so there's a lot of indirection and search involved to find the PR. In general, it might be better to link PRs than issues and link from PRs to issues - the PR is more up to date and it contains the actual description of the change, rather than the motivation for it which often becomes outdated (as in the case here)

@corneliusroemer corneliusroemer changed the title Mention both related PR and issue in change log entry Link to PR in change log rather than issue Oct 15, 2024
@fengelniederhammer
Copy link
Contributor

There are a lot of links in the "issue body"(?). But the sidebar shows it quite clearly:
grafik

That's the point to look at. I also use to do that in other libraries when I search issues in artifacts that I don't know. There might be 100 comments and links, but this is the relevant information.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants