fitzgen opened PR #2671 from issue-templates
to main
:
Don't use HTML comments, as they are noisy, which makes the templates more
intimidating.Use "TODO" to clearly demarcate everywhere the issue reporter should fill in
some information.Use headers and white space abundantly, which makes it easier to visually
process the template and its sections at a glance, and less of an intimidating
wall of text.Fixes #2661
bjorn3 submitted PR Review.
bjorn3 created PR Review Comment:
There is still some inconsistency in casing between templates.
fitzgen updated PR #2671 from issue-templates
to main
.
pchickey submitted PR Review.
abrown submitted PR Review.
abrown submitted PR Review.
abrown created PR Review Comment:
Cranelift version or commit: e.g., `git describe`? Operating system: e.g., `uname -osr` Architecture: e.g., `lscpu | egrep 'Architecture|Model name'`
abrown created PR Review Comment:
I mean, we might want to think up the Windows/MacOS versions of some of those but that would answer @wycats' comments here.
abrown submitted PR Review.
fitzgen submitted PR Review.
fitzgen created PR Review Comment:
This removes the TODO hints that every other field they need to fill out has, makes the template wordier (which makes it more like an intimidating wall of text), and assumes a unix environment. Not convinced that this change is a clear win.
cfallin submitted PR Review.
cfallin created PR Review Comment:
+1 -- OS and architecture would likely be known by folks who would be reporting issues (we can always have a conversation in an issue if not or if we need more detail); whereas complex command pipelines make it look like we're asking for very specific and picky details and may scare folks away, I think.
fitzgen merged PR #2671.
Last updated: Dec 23 2024 at 13:07 UTC