Skip to content

Commit

Permalink
chore: simplify the issue and pull request templates (#26)
Browse files Browse the repository at this point in the history
  • Loading branch information
byCedric authored Sep 8, 2018
1 parent 51bfb73 commit dd17cde
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 48 deletions.
23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Bug report
about: Create a report to help us improve
---

### Description of the bug
How would you shortly summarise the issue?

### To Reproduce
What steps did you perform which led to this issue?

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'

#### Expected behavior
What did you expect to have happened?

#### Actual behavior
What did it actually result in?

### Additional context
Can you further explain the issue? E.g., information about version/environment or screenshots.
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: Feature request
about: Suggest an idea for this project

---

**Describe the feature you'd like**
A clear and concise description of what you want to happen.

**Additional context**
Add any other context or screenshots about the feature request here.
29 changes: 4 additions & 25 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,5 @@
<!--- Provide a general summary of your changes in the Title above -->
### Linked issue
Provide the issue(s) which this pull request relates to or fixes.

## Description

Describe your changes in detail.

## Motivation and context

Why is this change required? What problem does it solve?

If it fixes an open issue, please link to the issue here (if you write `fixes #num`
or `closes #num` within the commit message footer, the issue will be automatically closed when the pull is accepted.)

## Checklist:

Go over all the following points, and put an `x` in all the boxes that apply.
Please, please, please, don't send your pull request until all of the boxes are ticked.

- [ ] I have read the **[CONTRIBUTING](CONTRIBUTING.md)** document.
- [ ] My pull request addresses _exactly one_ patch/feature.
- [ ] I have created a _branch_ for this patch/feature.
- [ ] Each individual _commit_ in the pull request _is meaningful_.
- [ ] I have _added tests_ to cover my changes.
- [ ] If my change requires a change to the _documentation_, I have updated it accordingly.

If you're unsure about any of these, don't hesitate to ask. We're here to help!
### Additional context
Are there things the maintainers should be aware of before merging or closing this pull request?

0 comments on commit dd17cde

Please sign in to comment.