-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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_TEMPLATE.md #2030
Create ISSUE_TEMPLATE.md #2030
Conversation
This is fine with me. The travis build didn't finish, but this commit won't break anything as it only adds a template. |
Mind if I clean up some spelling and wording things for clarity? |
@henryrizzi The clearer, the better. @Tarrasch is spending less time on Luigi now-a-days. So if you'd like to submit a cleaner PR for a |
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.
Fixed a few spelling mistakes and reworded a few sentences. But I think those two points are a good starting point for an issue template!
ISSUE_TEMPLATE.md
Outdated
@@ -0,0 +1,12 @@ | |||
<!--- | |||
There's currently no strict procedure or guidelines to submitting issues. |
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 sounds better I think:
Currently, there are no strict procedures or guidelines for submitting issues.
ISSUE_TEMPLATE.md
Outdated
@@ -0,0 +1,12 @@ | |||
<!--- | |||
There's currently no strict procedure or guidelines to submitting issues. | |||
Briefuly, just use common sense. |
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.
In brief, please just use common sense.
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.
In brief
sounds weird. Perhaps In short, please just use common sense
ISSUE_TEMPLATE.md
Outdated
There's currently no strict procedure or guidelines to submitting issues. | ||
Briefuly, just use common sense. | ||
|
||
Common sense at least includes: |
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.
Common sense includes this at bare-minimum:
ISSUE_TEMPLATE.md
Outdated
* Use markdown to format all code/logs. Issues which are hard to read | ||
when rendered on GitHub might be closed with a friendly reminder of this. | ||
|
||
Also, if applicacable add steps to reproduce a bug. And feel free to include sample code. |
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.
Also, add steps to reproduce the bug if applicable. And sample code if you'd like. :)
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.
also, add steps to reproduce the bug, if applicable. Sample code would be nice too :)
Maybe it would be good to direct Issue and PR templates to this opensource contributions guide as a ( |
Thanks for your valuable feed back guys! @dlstadther, that's a fantastic link! I'll be sharing it with my friends too! :) |
There have been quite a lot of issues recently. By being explicit upfront. We can be less emotional and subjective when closing issues in the future. #2029 #2028 #2027