polished issues template (#2056)

- added version subsection
- better worded upstream technologies notice
- more clear instructions
This commit is contained in:
David Refoua 2019-03-07 16:59:46 +03:30 committed by Benjamin Staneck
parent ec42046297
commit 63128ed52f

View File

@ -10,16 +10,18 @@
• Searched for existing issues (including the **closed** ones) • Searched for existing issues (including the **closed** ones)
for the similar problems here: for the similar problems here:
https://github.com/cmderdev/cmder/issues?q=is:issue https://github.com/cmderdev/cmder/issues?q=is:issue
• Read the README.md and the Wiki: • Read both the README.md and the Wiki:
- https://github.com/cmderdev/cmder/blob/master/README.md - https://github.com/cmderdev/cmder/blob/master/README.md
- https://github.com/cmderdev/cmder/wiki - https://github.com/cmderdev/cmder/wiki
(What you may be asking here could already be explained there!) (What you may be asking here could already be explained there!)
• Please understand that Cmder by default uses ConEmu as the • Please understand that Cmder uses ConEmu as the default
underlying Terminal Emulator. If your issue is regarding underlying Terminal Emulator. If your issue is regarding
the **Terminal Emulator**, please visit the ConEmu issues page: the **Terminal Emulator**, please visit the ConEmu issues page:
https://github.com/Maximus5/ConEmu/issues?q=is:issue https://github.com/Maximus5/ConEmu/issues?q=is:issue
@ -30,35 +32,53 @@
make sure you open the issue in the correct place.) make sure you open the issue in the correct place.)
more info: https://conemu.github.io/en/ThirdPartyProblems.html more info: https://conemu.github.io/en/ThirdPartyProblems.html
• If you are asking for guides on how to integrate Cmder into • If you would like to ask for guides on how to integrate Cmder with
your favorite IDE of choice, or how to perform an specific your favorite IDE of choice, or how to perform a specific task
task with Cmder, make sure you visit our label section first! with Cmder, make sure you visit our label section first.
You may already have an answer under the Guides or Questions section. You may already have an answer under the Guides or Questions section.
For a list of labels, visit: For a list of labels, visit:
- https://github.com/cmderdev/cmder/labels - https://github.com/cmderdev/cmder/labels
(Be sure to also check “Closed” issues in the labels section!) (Be sure to also check “Closed” issues in the labels section!)
• If you are having an issue with any of the **upstream technologies**
that are used by Cmder, please make sure that the issue is reproducible
_only_ when used in combination with Cmder.
We may not directly address the issues related to the following tools:
- Clink, the default shell in Cmder
- ConEmu, the terminal emulator
- Git/MinGW, which also provide *NIX tools
- clink-completions, which provide autocomplete
The issues related to upstream technologies are marked as 👆 [name].
We'll try our best to help you -- but we recommend creating an issue
specifically at each of the corresponding repositories for the best
result.
► Try to reproduce the bug you're reporting, on a stand-alone edition
of each tool, without using Cmder. If the bug applies when the
mentioned tools are NOT used within Cmder, there's a good chance that
you should open the bug at the corresponding repo instead.
• If the issue is regarding the other upstream technologies that • Lastly, have a look at official documentation for Cmder over
Cmder uses (e.g. Clink, Git, etc), please make sure that the our website, and our wiki.
bug you are reporting only applies when they are used in
combination with Cmder. If the bug applies when the mentioned
tools are NOT used within Cmder, there's a good chance that
you should open the bug at the corresponding repo instead.
Read more on about Cmder on ConEmu docs: Read more on about Cmder on ConEmu docs:
https://conemu.github.io/en/cmder.html https://conemu.github.io/en/cmder.html
Thank you for making sure you are opening a new valid issue! Thank you for making sure you are opening a new valid issue!
--> -->
<!-- <!--
Some tips on how to write a better report: Some tips on how to write a better report:
- Put an `x` into all the boxes [ ] relevant to your issue (example: [x]). - Put an `x` into all the boxes [ ] relevant to your issue (correct example: [x] • not like this: [ x] or [x ]).
- Use the *Preview* tab to see how your issue will actually look like, before sending it. - Use the *Preview* tab to see how your issue will actually look like, before sending it.
- Make sure the description is worded well enough to be understood, and with as much context and examples as possible. - Make sure the description is worded well enough to be understood, and with as much context and examples as possible.
- Post a screenshot or the command the triggered the problem, if applicable. - Post a screenshot or the command the triggered the problem, if applicable.
@ -66,6 +86,7 @@
Help us reproduce the issue by explaining what went wrong, and what did you expect to happen. Help us reproduce the issue by explaining what went wrong, and what did you expect to happen.
- Please keep the ticket language to English only here. - Please keep the ticket language to English only here.
We can't process your issue if it's written in Russian or Chinese as we can't understand them. We can't process your issue if it's written in Russian or Chinese as we can't understand them.
- You can find the version of Cmder.exe and ConEmu.exe binaries using Right Click → Properties → Details menu.
- ⚠ Read the following page to avoid posting a bad issue: https://conemu.github.io/en/BadIssue.html - ⚠ Read the following page to avoid posting a bad issue: https://conemu.github.io/en/BadIssue.html
--> -->
@ -74,5 +95,8 @@
- [ ] Feature request (request for new functionality) - [ ] Feature request (request for new functionality)
- [ ] Question - [ ] Question
### Version Information
<!-- Please write your Cmder and ConEmu version here -->
### Description of the issue ### Description of the issue
<!-- Provide a clear, simple description of your issue here --> <!-- Provide a clear, simple description of your issue here -->