Skip to content

Commit

Permalink
chore: add pr and issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
gphorvath committed Oct 28, 2024
1 parent f1c79aa commit d4b7685
Show file tree
Hide file tree
Showing 5 changed files with 90 additions and 0 deletions.
Empty file removed .github/ISSUE_TEMPLATE/.gitkeep
Empty file.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Bug Report
about: Create a report to help us improve
title: '[BUG] '
labels: bug
assignees: ''
---

## Description
Provide a clear and concise description of the bug.

## Steps to Reproduce
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. See the error

## Expected Behavior
Provide a clear and concise description of what you expected to happen.

## Additional Context
Add any other context about the problem here (e.g., screenshots, environment, versions, etc.).
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/chore.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Chore
about: Maintenance, refactoring, and housekeeping tasks
title: '[CHORE] '
labels: chore
assignees: ''
---

## Description
Provide a brief description of the chore needed.

## Motivation
Why is this chore important? What problems does it solve or prevent?

## Technical Details
Include any specific technical details, dependencies, or areas that will be affected.

## Risk Assessment
- Impact level: (Low/Medium/High)
- Areas affected:
- Potential side effects:

## Additional Notes
Include any other relevant information or context.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Feature Request
about: Suggest an idea for this project
title: '[FEATURE] '
labels: enhancement
assignees: ''
---

## Story

**As a** [persona],
**I want** [feature],
**so that** [benefit].

## Proposed Solution
Provide a clear description of what you want to happen.

## Alternatives Considered
Provide a clear description of any alternative solutions or features you've considered.

## Additional Context
Add any other context or screenshots about the feature request here.
22 changes: 22 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## Description
Brief description of the changes

## Type of change
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [ ] Documentation update

## How Has This Been Tested?
Describe how you tested these changes.

## Checklist:

- [ ] Your code is clean, understandable, and commented.
- [ ] All workflows are passing.
- [ ] You have sought at least one review from a key contributor or code owner.
- [ ] Tests are written to prevent recurrence of any known bugs.
- [ ] Documentation is sufficient for other contributors (or your future self) to work with your code.

## Related Issues
Fixes #(issue)

0 comments on commit d4b7685

Please sign in to comment.