search

GenSpectrum / LAPIS

An API, a query engine, and a database schema for genomic sequences; currently with a focus on SARS-CoV-2
https://lapis-three.vercel.app
GNU Affero General Public License v3.0
21 stars 6 forks source link

Link to PR in change log rather than issue #990

Open corneliusroemer opened 3 hours ago

corneliusroemer commented 3 hours ago

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: https://github.com/GenSpectrum/LAPIS/pull/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 commented 3 hours ago

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

corneliusroemer commented 3 hours ago

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)

fengelniederhammer commented 3 hours ago

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.