Skip to content

New ISSUE_TEMPLATE.md file #1637#1638

Merged
karmatosed merged 3 commits intoWordPress:masterfrom
DevinWalker:add/issue-template.md
Jul 4, 2017
Merged

New ISSUE_TEMPLATE.md file #1637#1638
karmatosed merged 3 commits intoWordPress:masterfrom
DevinWalker:add/issue-template.md

Conversation

@DevinWalker
Copy link
Copy Markdown
Contributor

PR Overview

Added an ISSUE_TEMPLATE.md file as a baseline. This is the one we use in our projects and it has been working pretty nicely for us.

If you have any suggested edits, just let me know!

Ref: #1637

Copy link
Copy Markdown
Member

@ntwb ntwb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also see #1637

@@ -0,0 +1,29 @@
## Issue Overview
Copy link
Copy Markdown
Member

@ntwb ntwb Jul 2, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably above this should be a link to CONTRIBUTING.md

<!-- Not obligatory, but suggest a fix/reason for the bug, -->
<!-- or ideas how to implement the addition or change -->

## Steps to Reproduce (for bugs)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd reorder this, the sections should be in the order of:

## Steps to Reproduce (for bugs)
## Expected Behavior
## Current Behavior

It allows the issue reader to gain an overview of the events that led up to the "current behaviour" they see

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes sense to me!

@youknowriad
Copy link
Copy Markdown
Contributor

Should we add a comment asking to look for duplicates before opening an issue?

@DevinWalker
Copy link
Copy Markdown
Contributor Author

@youknowriad yes, that's definitely a good idea. I'll add that text.

- If you're requesting a new feature, explain why you'd like it to be added.
- Search this repository for the issue and whether it has been fixed or reported already.
- Ensure you are using the latest code before logging bugs.
- Disabled all plugins to ensure it's not a plugin conflict issue.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/Disabled/Disable

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.

5 participants