Skip to content

Commit

Permalink
Add issue/PR templates (#111)
Browse files Browse the repository at this point in the history
* Add issue templates

Bug report, Feature request

* Add pull request template
  • Loading branch information
bivashy authored Nov 2, 2023
1 parent febd2e0 commit 98e4af7
Show file tree
Hide file tree
Showing 3 changed files with 74 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Bug report
about: Create a report to help us improve
title: "[Bug] "
labels: 'status: needs testing, type: bug'
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Launch '...'
2. Execute '....'
3. See error

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

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[Feature] "
labels: 'type: enhancement'
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**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.
28 changes: 28 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## Pull Request Etiquette

<!--
There are several guidelines you should follow in order for your
Pull Request to be merged.
-->

- [ ] I have checked the PRs for upcoming features/bug fixes.

<!--
It is sometimes better to include more changes in a single commit.
If you find yourself having an overwhelming amount of commits, you
can **rebase** your branch.
-->

### Changes

- [ ] Internal code
- [ ] API (affecting end-user code)
- [ ] Other: \_____ <!-- Insert other type here -->

<!-- Replace "NaN" with an issue number if this is a response to an issue -->

Closes Issue: NaN

## Description

Replace this sentence with general description of what your Pull Request does.

0 comments on commit 98e4af7

Please sign in to comment.