-
Notifications
You must be signed in to change notification settings - Fork 33
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
Create issue templates #216
Conversation
Let me know if anything needs to be tweaked. If so, I'll update auk, and warclight. |
Codecov Report
@@ Coverage Diff @@
## master #216 +/- ##
=======================================
Coverage 66.16% 66.16%
=======================================
Files 34 34
Lines 665 665
Branches 124 124
=======================================
Hits 440 440
Misses 184 184
Partials 41 41 Continue to review full report at Codecov.
|
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.
This looks fantastic. I just had a few minor suggestions which you can take or leave. 😄 Then I think it is ready to merge.
.github/ISSUE_TEMPLATE/Bug_report.md
Outdated
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Desktop (please complete the following information):** |
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.
Maybe specify "Desktop/Laptop" (don't laugh, I've seen this throw people off)
.github/ISSUE_TEMPLATE/Bug_report.md
Outdated
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: |
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.
add an e.g.
to make clear that they should tweak these steps and not try to shoehorn their workflow into the ellipses
.github/ISSUE_TEMPLATE/Bug_report.md
Outdated
If applicable, add screenshots to help explain your problem. | ||
|
||
**Desktop (please complete the following information):** | ||
- OS: [e.g. iOS] |
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.
change example to
[e.g. MacOS 10.13.3]
Looks great @ruebot! Just a quick question: what happens in the workflow if a user wants to request a feature (e.g. for AUK) but doesn't have GitHub account? I know we want to encourage everyone to fill out the template through Git, but just thinking about someone who may only be using AUK through the GUI. (this may be a questions for down the line). |
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.
Looks great @ruebot! Examples given are very helpful!
@SamFritz Slack or email? Then we could create an issue. Good question though. |
Good point! If they click "new issue" w/o an account they'll get this. So maybe in places on the platform, etc. where we provide a link to "open an issue," we could also have an invitation to join our Slack group or e-mail us? If that sounds good, we can merge this and keep this in mind for places where we invite people to open issues? |
I think email might be easier to manage (in terms of documenting specific cases/instances of features/bugs, Slack blends all conversations together). But I also realize that more and more people are on Slack. :) Merge sounds good! |
No description provided.