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 Templates #21

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 21 additions & 16 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,29 @@ assignees: ''

---

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

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
(Summarize the bug encountered concisely)

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

**Screenshots**
If applicable, add screenshots to help explain your problem.
(How one can reproduce the issue - this is very important)

**Desktop (please complete the following information):**
- OS: [e.g. ubuntu-18.04]
## What is the current bug behavior?

**Additional context**
Add any other context about the problem here.
(What actually happens)

## What is the expected correct behavior?

(What you should see instead)

## Relevant logs and/or screenshots

(Paste any relevant logs - use code blocks (```) to format console output, logs, and code, as
it's very hard to read otherwise.)

## Possible fixes

(If you can, link to the line of code that might be responsible for the problem)

/label ~bug ~reproduced ~needs-investigation
17 changes: 9 additions & 8 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,15 @@ 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 [...]
### Description
Describe feature request...

**Describe the solution you'd like**
A clear and concise description of what you want to happen.
### Why?
Why is the feature important?

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
### Estimated Effort
How long will this take?

**Additional context**
Add any other context or screenshots about the feature request here.
### Changes to be Made:
- Change 1
- Change 2
27 changes: 27 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Merge request
about: Create a request to help us grow
title: ''
labels: ''
assignees: ''

---

### Description
This merge request addresses...

### Changes Made to Code:
- Change 1
- Change 2

### Related
Provide link to task or issue..

### Additional Notes
Any extra needed information..

### Quality Checks
- [ ] New code is 100% tested
- [ ] Code has been formated
- [ ] Code has been linted
- [ ] Docstrings for new methods have been added