Skip to content

Conversation

@Anonymouqs
Copy link
Contributor

This issue template is designed to encourage clearer debug reports and more concise feature requests.

This issue template is designed to encourage clearer debug reports and more concise feature requests.
@tresf
Copy link
Member

tresf commented Feb 27, 2018

Related #2348. The shorter, the better, and please make the formatting perfect.

  1. Link your own bug tracker where we can test this out.
  2. Try not to be overly wordy. e.g., don't define stuff in your instructions. This isn't a EULA. Cross-link to wiki if there's potential for misunderstanding.

In general, most conversations should take place in the IRC Channel except in rare cases. IRC: http://webchat.freenode.net/?channels=%23lmms

Nope. Also, irony because you've been violating this rule. ;)

This file really adds a bunch of TL;DR. Let's take a second swing at it. Put yourself in the shoes of a person that just had a crash with LMMS. Get the most information fastest.

Next, put yourself in the shoes of a person wanting a small feature added. Get the most information fastest.

Speaking personally, I have a high standard for technical writing as well as experience seeing success and failure when too much information is thrown at an end user, bug submitter, etc. Perhaps you should have followed your conversation proposal and asked the devs about this on Discord first. :)

Anyway, we'd be happy to add an issue template if it adds value without adding clutter. 👍

@tresf
Copy link
Member

tresf commented Feb 27, 2018

For reference, here's how Homebrew does it... https://github.com/Homebrew/homebrew-core/issues/new

(theirs is a bit on the harsh side because of the nature of their tracker, ours would be a bit nice).

Change the template into a "fill in the blanks format"
@tresf
Copy link
Member

tresf commented Mar 14, 2018

Proposal below.

Demo of what it looks like here: https://gist.github.com/tresf/1fc66be7d80b975f04b9f9bc22348136

<!-----------------------------
|                             |
|     BUG REPORT TEMPLATE     |
|                             |
|  DELETE SECTIONS AS NEEDED  |
|                             |
------------------------------>
### Bug Summary

#### Steps to reproduce

#### Expected behavior

#### Actual behavior

#### Screenshot

**Logs**
<details>
  <summary>Click to expand</summary>
(remove this slash-->)\```
# paste here
(remove this slash-->)\```
</details>

<!-----------------------------
|                             |
|    ENHANCEMENT TEMPLATE     |
|                             |
|  DELETE SECTIONS AS NEEDED  |
|                             |
------------------------------>

### Enhancement Summary

#### Justification

#### Mockup

@lukas-w
Copy link
Member

lukas-w commented May 7, 2018

FYI, GitHub now supports multiple templates by storing them in the directory .github/ISSUE_TEMPLATE: https://blog.github.com/2018-05-02-issue-template-improvements/

image

@lukas-w lukas-w mentioned this pull request Mar 10, 2019
@lukas-w
Copy link
Member

lukas-w commented Oct 29, 2019

Closing in favour of #4884.

@lukas-w lukas-w closed this Oct 29, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants