Skip to content

Commit

Permalink
Merge pull request #271 from bancorprotocol/issue-templates
Browse files Browse the repository at this point in the history
Update issue templates
  • Loading branch information
zavelevsky authored Dec 25, 2023
2 parents af52961 + 61e3610 commit 2ae95e0
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

---

## Bug Description
- Summary of the bug

## Severity (High/Medium/Low)
- Rate the severity. High: "I can't/won't use the bot due to this", Low: "I can work around it", Medium: (anything in between).

## Steps to Reproduce
- Step-by-step reproduction method, include environment information if relevant - such as Python version and OS.

## Expected Behavior
- What should happen

## Actual Behavior
- What currently happens

## Impact Analysis (to be filled by contributors)
- Automated Tests: Are there existing tests covering this? Do we need new tests?
- Risks: Potential areas affected by this bug and its probable fix
- Performance: Is this bug affecting performance?
- Monitoring: Does this affect any current monitoring? Any new alerts needed?
- Logging: Any changes required in logging?
- Documentation: Updates needed in documentation?
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Enhancement
about: A detailed description of the planned enhancement
title: ''
labels: enhancement
assignees: ''

---

## Enhancement Description
- Summary of the enhancement

## Rationale
- Why is this enhancement important?

## Impact Analysis
- Automated Tests: Implications on testing (new/changed)
- Risks: What are the risks associated with this enhancement?
- Performance: Expected performance impacts and how to measure them
- Monitoring: Changes required in the monitoring system
- Logging: Do we need additional logs?
- Documentation: Updates or new documentation needed?
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: ''
labels: 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.

0 comments on commit 2ae95e0

Please sign in to comment.