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

Create ISSUE_TEMPLATE.md #2030

Merged
merged 2 commits into from
Feb 24, 2017
Merged

Create ISSUE_TEMPLATE.md #2030

merged 2 commits into from
Feb 24, 2017

Conversation

Tarrasch
Copy link
Contributor

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

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
@dlstadther
Copy link
Collaborator

This is fine with me. The travis build didn't finish, but this commit won't break anything as it only adds a template.

@henryrizzi
Copy link
Contributor

Mind if I clean up some spelling and wording things for clarity?

@dlstadther
Copy link
Collaborator

dlstadther commented Feb 17, 2017

@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 ISSUE_TEMPLATE.md, feel free.

Copy link
Contributor

@henryrizzi henryrizzi left a 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!

@@ -0,0 +1,12 @@
<!---
There's currently no strict procedure or guidelines to submitting issues.
Copy link
Contributor

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.

@@ -0,0 +1,12 @@
<!---
There's currently no strict procedure or guidelines to submitting issues.
Briefuly, just use common sense.
Copy link
Contributor

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.

Copy link
Collaborator

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

There's currently no strict procedure or guidelines to submitting issues.
Briefuly, just use common sense.

Common sense at least includes:
Copy link
Contributor

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:

* 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.
Copy link
Contributor

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. :)

Copy link
Collaborator

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 :)

@dlstadther
Copy link
Collaborator

Maybe it would be good to direct Issue and PR templates to this opensource contributions guide as a (for more information on how to submit valuable contributions, see https://opensource.guide/how-to-contribute/#how-to-submit-a-contribution).

@Tarrasch Tarrasch merged commit 548ff70 into master Feb 24, 2017
@Tarrasch Tarrasch deleted the Tarrasch-patch-1 branch February 24, 2017 02:16
Tarrasch added a commit that referenced this pull request Feb 24, 2017
@Tarrasch
Copy link
Contributor Author

Thanks for your valuable feed back guys!

@dlstadther, that's a fantastic link! I'll be sharing it with my friends too! :)

dlstadther pushed a commit that referenced this pull request Feb 24, 2017
This was referenced Jun 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants