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

Ideas for improved issue templates #1741

Draft
wants to merge 4 commits into
base: master
from

Conversation

@fredreichbier
Copy link
Member

commented Jul 9, 2019

Some ideas for shorter/more concise issue templates. Happy about any comments!

fredreichbier added some commits Jul 8, 2019

@codecov

This comment has been minimized.

Copy link

commented Jul 9, 2019

Codecov Report

Merging #1741 into master will increase coverage by 0.04%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1741      +/-   ##
==========================================
+ Coverage   97.02%   97.07%   +0.04%     
==========================================
  Files         149      149              
  Lines       18040    18337     +297     
==========================================
+ Hits        17504    17800     +296     
- Misses        536      537       +1
Impacted Files Coverage Δ
privacyidea/api/policy.py 99% <0%> (-0.28%) ⬇️
privacyidea/lib/utils/compare.py 100% <0%> (ø) ⬆️
privacyidea/lib/tokens/yubikeytoken.py 97.67% <0%> (+0.05%) ⬆️
privacyidea/lib/policy.py 99.44% <0%> (+0.16%) ⬆️
privacyidea/lib/tokens/tiqrtoken.py 98.88% <0%> (+0.2%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0fe8ee5...3973a94. Read the comment docs.


* Webserver:
**Operating System**:

This comment has been minimized.

Copy link
@Mipronimo

Mipronimo Jul 9, 2019

Member

We should add
**Python version**:

This comment has been minimized.

Copy link
@fredreichbier

fredreichbier Jul 29, 2019

Author Member

thanks, added in the next revision


* OS:
**Installation method**: (from source, github, virtualenv, ubuntu packages...)

This comment has been minimized.

Copy link
@plettich

plettich Jul 10, 2019

Member

pip?
what is the difference between source and github?

This comment has been minimized.

Copy link
@fredreichbier

fredreichbier Jul 29, 2019

Author Member

good point, I reformulated the points a bit

fredreichbier added some commits Jul 29, 2019


### Log file

**Turn on debug level and take a look at the privacyidea.log!**
**If appropriate, attach the log file.**
**Set PI_LOGLEVEL = logging.DEBUG in pi.cfg and take a look at the privacyidea.log!**

This comment has been minimized.

Copy link
@plettich

plettich Jul 30, 2019

Member

Can we use Code-format in these templates? Might make the text more readable.

@@ -1,67 +1,52 @@
---
name: Bug report
about: Create a report to help us improve

This comment has been minimized.

Copy link
@cornelinux

cornelinux Aug 6, 2019

Member

I would like to provide a wording that tells all contributors that their filing a bug actually is a contribution which comes with a certain responsibility and not simply a complaint that something works wrong in their opinion.
Filing a bug is not fingerpointing but helping.

-->

# What did you try to do?

Please provide your top level intent!

This comment has been minimized.

Copy link
@cornelinux

cornelinux Aug 6, 2019

Member

When filing bug reports or support requests people often forget to actually tell what their intention is. They might say "i did this and that", but this often did not help to understand their situation. They try to be precise but often forget things.
I found it very helpful to ask them, what they actually want to achieve! This is why there is the question for the "top level intent": What was your intention?

Please provide steps to reproduce!

# What outcome did you expect?
### Top-level intent

This comment has been minimized.

Copy link
@cornelinux

cornelinux Aug 6, 2019

Member

Hm, here it is - the top level intent. I think I got lost in the github diff-view.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.