Skip to content

Commit

Permalink
Merge pull request #127 from tisnik/templates-for-pr-and-issues
Browse files Browse the repository at this point in the history
Templates for PRs and issues
  • Loading branch information
tisnik committed Aug 29, 2019
2 parents f712d17 + cee38f4 commit 03f1ea8
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 0 deletions.
34 changes: 34 additions & 0 deletions ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,34 @@
---
name: Bug report
about: Create a report to help us improve this project
title: ''
labels: ''

---

_Instructions: Replace the template text and remove irrelevant text (including this line)_

**Describe the bug**
A clear and concise description of what the bug is.
(Issues related to the runtime files should be reported to their maintainer, check the file header.)

**To Reproduce**
Detailed steps to reproduce the behavior:
1.
2.
3.
4.

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, copy/paste the text or add screenshots to help explain your problem.

**Environment (please complete the following information):**
- Project version [e.g. 1.0.0]
- OS: [e.g. Ubuntu 18.04, Windows 10 1809, macOS 10.14]
- Terminal: [e.g. GNOME Terminal, mintty, iTerm2, tmux, GNU screen]

**Additional context**
Add any other context about the problem here.
22 changes: 22 additions & 0 deletions ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,22 @@
---
name: Feature request
about: Suggest an enhancement for this project
title: ''
labels: enhancement

---

_Instructions: Replace the template text and remove irrelevant text (including this line)_

**Is your feature request related something that is currently hard to do? Please describe.**
A clear and concise description of what is hard to do. Ex. It is difficult to [...] when [...]
(If it is related to runtime files, please check their header for where to discuss enhancements.)

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

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
14 changes: 14 additions & 0 deletions PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,14 @@
# Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

## Type of change

Please delete options that are not relevant.

- [ ] 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 not work as expected)
- [ ] This change requires a documentation update

0 comments on commit 03f1ea8

Please sign in to comment.