Skip to content

Commit

Permalink
Merge pull request #85 from rofrano/add-templates
Browse files Browse the repository at this point in the history
Added Issue templates for user feedback
  • Loading branch information
rahlk authored Dec 19, 2024
2 parents 1f0f81c + 78ff012 commit 9792b65
Show file tree
Hide file tree
Showing 3 changed files with 93 additions and 0 deletions.
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

### Describe the bug

A clear and concise description of what the bug is.

### Steps To Reproduce

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

### Observed behavior

Describe what you saw and why you think it's a bug?

### Expected behavior

A clear and concise description of what you expected to happen.

### Screenshots

If applicable, add screenshots to help explain your problem.

### Environment (please complete the following information):

- OS: [e.g. macOS 15.1 | Windows 11]
- Version of Java
- Version of Maven
- Version of Gradle

### Additional context

Add any other context about the problem here.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
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.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/user_story.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: User Story
about: Use this for creating User Stories
title: ''
labels: ''
assignees: ''

---

### Feature

**As a** [role]
**I need** [functionality]
**So that** [benefit]

### Details & Assumptions

- document what you know here...

### Acceptance Criteria

```gherkin
Given [some initial state]
When [some event]
Then [some measurable outcome]
```

0 comments on commit 9792b65

Please sign in to comment.