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.

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

Update of Issue and Pull Request Templates #101

Merged
merged 5 commits into from May 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
29 changes: 19 additions & 10 deletions .github/ISSUE_TEMPLATE/bug_report.md
Expand Up @@ -7,28 +7,37 @@ assignees: ''

---

**Describe the bug**
### Describe the bug
<!-- A clear and concise description of what the bug is. Please write a complete, reproducible, specific bug report. -->

<!-- You must include a clear, concise description of the problem, and a set of instructions for replicating it. Add as much debug information as you can. A nice small test case is the best way to report a bug, as it gives us a helpful way to confirm the bug quickly. -->

**To Reproduce**
- TBF

### To Reproduce

Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
### Expected behavior
<!-- A clear and concise description of what you expected to happen. -->

**Screenshots**
- TBF

### Screenshots
<!-- If applicable, add screenshots to help explain your problem. -->

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
- TBF

### System information
<!-- Please complete the following information. -->

- OS: [e.g. Microsoft Windows 11 Pro 22H2]
- Version [e.g. v0.1.3]

**Additional context**
### Additional context
<!-- Add any other context about the problem here. -->

- TBF
18 changes: 13 additions & 5 deletions .github/ISSUE_TEMPLATE/feature_request.md
Expand Up @@ -7,14 +7,22 @@ assignees: ''

---

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

**Describe the solution you'd like**
- TBF

### Solution
<!-- 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. -->
- TBF

### Alternative solution(s)
<!-- A clear and concise description of any alternative solution(s) or feature(s) you've considered. -->

**Additional context**
- TBF

### Additional context
<!-- Add any other context or screenshots about the feature request here. -->

- TBF
24 changes: 16 additions & 8 deletions .github/pull_request_template.md
@@ -1,25 +1,33 @@
<!-- Provide a general summary of your changes in the _Title_ above. -->

**Checklist:**
### Checklist
- [ ] Have you followed the guidelines in our Contributing document?
- [ ] Have you checked to ensure there aren't other open Pull Requests for the same update/change?
- [ ] Added **tests** for changed code.
- [ ] Updated **documentation** for changed code.

**Description**

### Description
<!-- Describe your changes in detail. -->

**Related Issue**
- TBF

<!-- This project only accepts pull requests related to open issues. If suggesting a new feature or change, please discuss it in an issue first. If fixing a bug, there should be an issue describing it with steps to reproduce. Please link to the issue here: -->
### Related Issue
<!-- This project only accepts pull requests related to open issues. If suggesting a new feature or change, please discuss it in an issue first. -->
<!-- If fixing a bug, there should be an issue describing it with steps to reproduce. -->

**Motivation and Context**
- Resolve #???;

### 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. -->

**How Has This Been Tested**
- TBF

### 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):**
- TBF

### Screenshots
<!-- Only if appropriate -->

- N/A