You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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
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
There are a lot of links in the "issue body"(?). But the sidebar shows it quite clearly:
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.
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.
The text was updated successfully, but these errors were encountered: