Skip to content

Commit

Permalink
chore: update pr and issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
mikeplotean committed Sep 16, 2024
1 parent f5c62f1 commit 9cfc4ba
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 37 deletions.
35 changes: 18 additions & 17 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,36 +7,37 @@ assignees: ''

---

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

**To Reproduce**
## 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.

**Actual behavior**
## Actual behavior

A clear and concise description of what actually happens.

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

- os version: [e.g. linux, windows, macos]
- docker version: [e.g. 27.0.1]
- compose version: [e.g. 2.28.1]
- java version [e.g. 18]

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

If applicable, add screenshots to help explain your problem.

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
## Additional context

**Additional context**
Add any other context about the problem here.
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,17 @@ 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.
32 changes: 12 additions & 20 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,18 @@
## Description
# Description

Provide a clear and concise description of the changes made in this pull request.
Provide a clear and concise description of the changes made in this pull request:

Fixes #[issue number]

## Type of Change

- [ ] 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
# Type of Change

## Checklist
- [ ] 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

- [ ] I have performed a self-review of my code
- [ ] If it is a core feature, I have added thorough tests
- [ ] Do we need to implement analytics?
- [ ] Will this be part of a product update? If yes, please write one phrase about this update.
- [ ] My code follows the style guidelines of this project
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream modules

# Checklist

- [ ] code cleanup and self-review
- [ ] unit + e2e test coverage
- [ ] documentation updated accordingly

0 comments on commit 9cfc4ba

Please sign in to comment.