Skip to content
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

Issue template - few extra suggestions for improvements #701

Closed
dreamcat4 opened this issue Aug 18, 2018 · 3 comments
Closed

Issue template - few extra suggestions for improvements #701

dreamcat4 opened this issue Aug 18, 2018 · 3 comments
Labels
stale Stale issue, closing soon.

Comments

@dreamcat4
Copy link

dreamcat4 commented Aug 18, 2018

Hi again.
Thank you for improving this. But it's still could do more baby-ing of the user. I will explain why (reasons) to help understand why:

OK so here is your current issue template:

<!--
* Update to the latest version.
* DYOR, check for existing issues/FAQ
* For support join the chats.
* If you want me to help you, please provide the information below
-->

#### Source
<!-- e.g. ppa:name, repository, from source, etc … -->

#### Environment
<!-- Albert version >= v0.14.22: albert --report -->
<!-- Albert version <= v0.14.21: cat /etc/issue; uname -r; env | grep -e SESSION_TYPE -e DESKTOP; qmake-qt5 -v; albert -v -->

#### Steps to reproduce

#### Expected behaviour

#### Actual behaviour

Now while that contains all the correct infos. People really respond better if they are asked a question. Because it makes them stop / think for a second.

This is a necessary step, because when someone has already decided to create an issue. And clicked the button: they already have something they want to say. And enter into the text field. Their own words.

So the question / start sentence is really needed to get them to be like 'hold on' i need to do this first. Otherwise (just like me earlier). User is more likely just to delete all the existing text. So they can write their own comment.

So guideline is to:

  • Start with a question (make them stop). Like:
  • Then re-inforce that with an instruction, what they must do.
  • Don't ask too much. Because there is a finite amount of things you can ask for, before it is too much, and get in the way of their workflow. Which is already in progress. Because they already clicked the 'New issue' button. And already have something in their mind they wanted to say.
  • A more polite / clever solution (than to ask everything up front) is to employ a 'bot'. To ask the remaining questions as follow up question after their 1st comment. For example: The ansible/ansible project uses bots heavily. But let's assume we don't have that luxury... we would expect that's a lot of hassle to setup.

Here is my example. How I would try to do it. It's not perfect though!

Were you planning to delete this form text !??!?

Before submitting *ANY* issue, please run the following command(s). To provide the exact versions of the software components on your system. Just copy/paste the following command(s) into a terminal window...

albert --report || cat /etc/issue; uname -r; env | grep -e SESSION_TYPE -e DESKTOP; qmake-qt5 -v; albert -v

And then paste it back below
-->
#### System Environment

<!-- ...It's also really helpful to do the following things!

* Update to the latest version of alfred

* Do some prior research, and check the existing issues / FAQs

* Joined our chats yet? (how??? is there a link to them?? gitter/slack or something?)
-->

#### Source
<!-- e.g. ppa:name, repository, from source, etc … -->

#### Steps to reproduce

#### Expected behaviour

#### Actual behaviour

Well, I still feel it's too many template fields (5 total). You probably want to be aiming for as few as possible. Like 3 fields.

This is what the budgie project calls them:

**The issue encountered**

 ...

**Steps to reproduce the issue**

For example: there is not 'expected behaviour' field... because that assumes everybody needs that field. To be sure it's a bug w/e. In reality the other fields tend to tell us the story. (like what the user has assumed to get here, either correctly or incorrectly).

Hope the feedback is further useful !
Kind Regards

@dreamcat4
Copy link
Author

dreamcat4 commented Aug 18, 2018

OK so after reading that back to myself. It does not sound and good. Because it's much longer then your original template. ^^ that first try would be something your would tell a bot to say. As a follow up comment. It's not short enough. Needs fewer words.

2nd try:

<!-- Please:
* Update to the latest version
* Check for existing issues / FAQ
* Join the chats (?link?)
* If you want me to help you, please provide the information below
-->

#### Installation Source
<!-- e.g. ppa:name, repository, from source, etc … -->

#### Environment
<!-- Run command, copy-paste the output... -->

albert --report || (cat /etc/issue; uname -r; env | grep -e SESSION_TYPE -e DESKTOP; qmake-qt5 -v; albert -v)

**The issue encountered**

 ...

**Steps to reproduce the issue**

What I changed from your template:

  • Start / beginning: A bit little more polite.
  • Raised question about chat link (because I am not sure what you meant there).
  • Check version command: Combined 2 cmds --> 1 cmd. To work on all systems.
  • Removed the 'expected result' field - not needed. It makes people repeat themselves.
  • Changed the last texts to --> budgie project.

That's about it. I don't think I have any more suggestions for this template.

@stale
Copy link

stale bot commented Nov 5, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale Stale issue, closing soon. label Nov 5, 2020
@ManuelSchneid3r
Copy link
Member

changed to much meanwhile. however thank you. regards

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stale Stale issue, closing soon.
Development

No branches or pull requests

2 participants