Skip to content

Commit

Permalink
Update the pull request and issue templates
Browse files Browse the repository at this point in the history
- use smaller headings
- remove the checkboxes, as these imply that a choice is a set of things to be completed
- suggest that lines that don't apply are deleted
  • Loading branch information
gemmaleigh committed Feb 9, 2017
1 parent 9bab8cd commit 670311d
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 21 deletions.
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
<!--- Provide a summary of the issue in the Title above -->
<!--- Providing context helps us come up with a solution that is most useful in the real world -->

## How would you expect it to work?
#### How would you expect it to work?
<!--- If you're describing a bug, tell us what should happen -->
<!--- If you're suggesting a change/improvement, tell us how it should work -->

## How does it work currently?
#### How does it work currently?
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
<!--- If suggesting a change/improvement, explain the difference from current behavior -->

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

## Explain the steps to reproduce the bug
#### Explain the steps to reproduce the bug
<!--- Provide a link to a live example, or a set of steps. -->
1.
2.
3.
4.

## Tell us about your environment
#### Tell us about your environment
<!--- Include as many relevant details about the environment you experienced the bug in -->
* Version used:
* Browser Name and version:
Expand Down
29 changes: 13 additions & 16 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,24 @@
<!--- Provide a summary of your changes in the Title above -->

## What problem does the pull request solve?
#### What problem does the pull request solve?
<!--- Why is this change required? -->
<!--- If it fixes an open issue, please link to the issue here. -->

## What does it do?
<!--- Describe your changes -->

## How has this been tested?
#### How has this been tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->

## Screenshots (if appropriate):
#### Screenshots (if appropriate):

## What type of change is it?
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
#### What type of change is it?
<!--- What types of changes does your code introduce? Delete the lines below that don't apply. -->
- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing functionality to change)

## Put an `x` in all the boxes that apply
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have read the **CONTRIBUTING** document.
#### Has the documentation been updated?
<!--- Delete the lines below that don't apply -->
- My change requires a change to the documentation.
- I have updated the documentation accordingly.
- I have read the **CONTRIBUTING** document.

0 comments on commit 670311d

Please sign in to comment.