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
wip: hardened issue template #6988
base: master
Are you sure you want to change the base?
Conversation
Other inspiration: https://obsproject.com/blog/how-to-contribute-to-open-source |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For context
Homebrew/brew@6676e40
https://github.com/Homebrew/brew/pull/3085
Also note how I put it in the feature request template, which I think has been very successful. Feature requests have been much clearer and more targeted.
|
Yeah.
Valid point, @Frenzie suggestion works for me.
Maybe: "Unless you're reporting a crash you're required to enable debug logs first." |
Follow up: pushed this to my master branch too, so the changes here can be previewed in https://github.com/pazos/koreader/issues/new/choose |
I have to wonder if we can't keep it a little bit more concise? But looks fine in principle. |
Not super fond of the tone :) and the heavy wrapping (10% user text for 90% static text probably). I'm usually quite fine with a single sentence and most often, they make sense even if the version/device is not provided. |
Segmentation of text based on the nature of the bug/feature? For example, a few quick templates:
|
Is a bit harsh for me too :/. Specially the part of |
Please read and fill out the issue checklist below, and provide all requested information. If you don't, a kitten will be killed and you won't be our friend. If you end up repeatedly killing kittens, we will block you from submitting issues and killing more kittens. |
I'm on the same page. I don't like the brew bug templates. They're for developers, not users.
That's far too many, but we do need a document bug template, mainly to direct people to programs like epubcheck. |
Still wip ? Or are we fine with our soft template ? |
Leave it wip. I will try to make it soft while keeping some stuff than can make our janitor tasks easier :) |
The following first post has some links to some issue template which happens to look like what you wanted, but also quite more html-form-like than what you got above :) |
Yeah, GitHub Issue Forms are new since roughly half a year ago. They still say "Note: Issue forms are currently in beta for public repositories on GitHub.com only." I don't like a bunch of meaningless checkboxes and too many required fields but it could be useful to absolutely require the version. It surprises me a bit but there's been a number of issues where it turned out the OP was using a version from over a year ago. |
Are there any new thoughts/insights here? |
Not really. I've commented elsewhere: #8902 (comment)
|
Shameless copy from
brew
's bug templateAdapted to document crash.log creation and test case reports for documents. The main idea is to make our lives easier.
This change is