Create issue templates

[grst]

I think this repo should provide sensible default issue templates and link to the scverse discourse for help requests.

[Zethson]

New style tho, please. The actual forms

[grst]

I tried setting that up for scirpy. Feedback welcome!

https://github.com/scverse/scirpy/issues/new/choose

• One issue I'm having is that I didn't find a way to make the version info collapsible. Either there's still some need for a markdown template within the form, or it won't be collapsed.

Once we are happy with it there, I'll copy it over to this repo.

[grst]

Link to a demo bug report:
scverse/scirpy#340

The section Version Information is quite unusable atm... maybe better to just use a plain text field. This might result in a very long issue, but 🤷

[Zethson]

Great!

"plase paste the output between the backticks "

Typo

I'm a fan of the background text that you have in the other cells. Maybe this would also be something for the version information?
But this seems to be a decent version

Not collapsible, but I don't know how to make that work either.

[grst]

Yeah, I think I'm gonna get rid of the template for making it collapsible. Should we still advertise for putting the full list of versions returned by `sc.logging.print_versions()` or rather ask for a few specific ones (the package itself and maybe numpy/pandas)?

…

On Fri, May 20, 2022, 11:27 Lukas Heumos ***@***.***> wrote: Great! "plase paste the output between the backticks " Typo I'm a fan of the background text that you have in the other cells. Maybe this would also be something for the version information? But this seems to be a decent version [image: image] <https://user-images.githubusercontent.com/21954664/169498695-5ee67db1-d295-46c2-b695-1ad3f579357c.png> Not collapsible, but I don't know how to make that work either. — Reply to this email directly, view it on GitHub <#57 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABVZRV4VSCIFWIJNV4HV42DVK5LJRANCNFSM5V54W6LA> . You are receiving this because you were assigned.Message ID: ***@***.***>

[Zethson]

Not sure whether all of our ecosystem packages require scanpy as a dependency. Some people may not know where this command comes from. I'd go with a "manual" approach (what you suggested)

[grst]

New version: https://github.com/scverse/scirpy/blob/9665b2d5d011ce1df230809050c800f264dba095/.github/ISSUE_TEMPLATE/bug_report.yml

[Zethson]

MuData version might also be relevant. Maybe we should ask users to run https://pypi.org/project/session-info/ ? This might be the most general version.

[ivirshup]

sc.logging.print_versions() is just session-info.

Lesson learned from scanpy: get people to report all imported packages in the session where the bug occurred. This will save many hours of debugging.

[Zethson]

sc.logging.print_versions() is just session-info.

Yeah, I'm aware. But then people don't need to have scanpy installed. In the future, some people may be using environments without scanpy.

[grst]

How confident are we about the state of session-info?

There's some evidence that in the past issues with that package weren't resolved very quickly:
https://gitlab.com/joelostblom/session_info/-/issues/8
https://gitlab.com/joelostblom/session_info/-/issues/10

Therefore, I have some concerns making it a depdendency

[ivirshup]

Stuff eventually got fixed, but there is also https://github.com/IBM/import-tracker which may be able to do the same (though I haven't tried it)

[grst]

Another one https://pypi.org/project/depinfo/

…

On Mon, May 30, 2022, 21:31 Isaac Virshup ***@***.***> wrote: Stuff eventually got fixed, but there is also https://github.com/IBM/import-tracker (which I haven't tried) — Reply to this email directly, view it on GitHub <#57 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABVZRV6DRBEZTYANZ4DP7CTVMUJQ7ANCNFSM5V54W6LA> . You are receiving this because you were assigned.Message ID: ***@***.***>

[ivirshup]

I think session-info is going to be the most mature and maintained option here.

[grst]

I'm still a bit wary of making it a dependency. This would mean that if session-info breaks, all scverse packages break (similar impact as e.g. numpy).

The actual code getting the version information seems quite straightforward. We could consider including the actual code in the template or putting it into a "scverse-tools" package (cf #72). Like that we would at least have control over it.