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.

Sign up for GitHub

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

New ISSUE_TEMPLATE.md file #1637 #1638

Merged
merged 3 commits into from
Jul 4, 2017
Merged

New ISSUE_TEMPLATE.md file #1637 #1638

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
85c0406
New ISSUE_TEMPLATE.md file #1637
DevinWalker Jul 1, 2017
ca35cb8
Reordered per @ntwb suggestions
DevinWalker Jul 2, 2017
1853deb
Added "BEFORE POSTING YOUR ISSUE" section within html comments to pro…
DevinWalker Jul 3, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## Issue Overview
Copy link
Member

@ntwb ntwb Jul 2, 2017 •
edited
Loading

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

<!-- This is a brief overview of the issue. --->

## Expected Behavior
<!-- If you're describing a bug, tell us what should happen -->
<!-- If you're suggesting a change/improvement, tell us how it should work -->

## Current Behavior
<!-- If describing a bug, tell us what happens instead of the expected behavior -->
<!-- If suggesting a change/improvement, explain the difference from current behavior -->

## Possible Solution
<!-- 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
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
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!

<!-- Provide a link to a live example, or an unambiguous set of steps to -->
<!-- reproduce this bug. Include code to reproduce, if relevant -->
1.
2.
3.
4.

## Related Issues and/or PRs
<!-- List related issues or PRs against other branches: -->

## Todos
- [ ] Tests
- [ ] Documentation