-
Notifications
You must be signed in to change notification settings - Fork 677
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
How to alert users of known issues with released cabal-install
?
#9955
Comments
Problem with “Known issues” lists is that they get stale easily. I don't know whether github supports regexps or search patterns to get all |
I most often get |
I have a very grumpy opinion on this matter. There are two kind of people, the ones which know how to use search, google and know how to read; and then all the other people. For the first category it's "enough" to keep a good track of issues. What is fixed and when, what isn't; which versions fixes are backported to etc. But just having complete changelogs are a very good start (including clean The second group of people will open an issue, ask on reddit, discourse etc. Then someone from the first group of people can find an issue for them and tell about it. In other words, you need to empower first group. TL;DR, you first need to have the data, keep it organised, and only then you can think about how to best present it. |
To highlight my point: #9952 is exactly "a known issue", but it wasn't recorded anywhere. |
I think the best way to signal known issues currently is the start of our changelogs, also called release notes, that live on master branch. They are editable via PRs. The only problem is that they are created during the release process, not before, so we'd need a place to stage known issues initially. Maybe just create that file ahead of the time with the only content being known issues? Regarding links, note that the Cabal Hackage package changelog is in .md format and has clickable links. Obviously cabal-install and cabal-install-solver should have their Hackage changelog files converted to that style and it'd be clickable as well. I don't know if there's an issue about that but if it is, it's many years old. |
How do we report known issues with released versions of
cabal-install
in a way that end users ofcabal-install
might notice?From a search of this repo, I found "known issues" in the output of the hidden
man
command. That cabal-install label has0 Open
and0 Closed
issues. Is that the right label?Up on hackage there's the changelog but what's the best way to alert users of a known issues with packages on hackage short of deprecating the release on hackage, do a revision and amend the changelog or something else?
Note
-*-change-log-*-
3.10.3.0 Hécate <hecate+github@glitchbra.in> January 2024
3.10.2.1 Hécate <hecate+github@glitchbra.in> November 2023
The text was updated successfully, but these errors were encountered: