Skip to content

Commit

Permalink
Adding GitHub Issue Templates (#713)
Browse files Browse the repository at this point in the history
* Create 0-feature.md

* Added GitHub issue templates
  • Loading branch information
christianmorfordwaitessw authored Jan 8, 2025
1 parent fe27ef5 commit 519056a
Show file tree
Hide file tree
Showing 5 changed files with 202 additions and 0 deletions.
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/0-feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
name: "✨ New Feature"
about: Suggest an idea
title: ""
labels: 'Type: Feature'
assignees: ''

---
<!-- These comments automatically delete -->
<!-- **Tip:** Delete parts that are not relevant -->
<!-- Next to Cc:, @ mention users who should be in the loop -->
Cc:
<!-- add intended user next to **Hi** -->
Hi {{ USER }}

### Pain
Explain the pain you are experiencing. This is **WHY** this must be done.

### Suggested Solution
<!-- Describe the solution you'd like -->

### Acceptance Criteria
Acceptance Criteria defines the requirements that must be met for the story to be completed. This is **WHAT** must be done.

See https://www.ssw.com.au/rules/acceptance-criteria.

1. {{ AC 1 }}

### Tasks
Tasks help developers to track small bits of work needed to meet the ACs. This is **HOW** the work will be done.

```[tasklist]
- [ ] {{ TASK 1 }}
```

### More Information
<!-- Add any other context here. -->

### Screenshots
<!-- If applicable, add screenshots to help explain your problem. -->

Thanks!
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
name: "\U0001F41B Bug Report"
about: Create a report to help us improve as per https://www.ssw.com.au/rules/the-right-way-to-report-bugs-and-give-feedback-suggestions
title: "\U0001F41B "
labels: 'Type: Bug'
assignees: ''

---
<!-- These comments automatically delete -->
<!-- **Tip:** Delete parts that are not relevant -->
<!-- Next to Cc:, @ mention users who should be in the loop -->
Cc:
<!-- add intended user next to **Hi** -->
Hi {{ USER }}

### Describe the Bug
<!-- A clear and concise description of what the bug is. -->

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

### Expected Behavior
<!-- A clear and concise description of what you expected to happen. -->

### Tasks
- [ ] Investigate
- [ ] Fix

### More Information
<!-- Add any other context about the problem here. -->

### Environment
- Device: [e.g. iPhone 12]
- Browser: [e.g. chrome, safari]
- OS: [e.g. iOS]

### Screenshots
<!-- If applicable, add screenshots to help explain your problem. -->


Thanks!
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/2-docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: "📝 Documentation"
about: Updating documentation (e.g. README, Wiki, Guides etc.) as per https://www.ssw.com.au/rules/awesome-documentation/
title: "📝"
labels: 'Type: Documentation'
assignees: ''

---
<!-- These comments automatically delete -->
<!-- **Tip:** Delete parts that are not relevant -->
<!-- Next to Cc:, @ mention users who should be in the loop -->
Cc:
<!-- add intended user next to **Hi** -->
Hi

### Pain
<!-- Explain the pain you are experiencing -->

### Suggested Documentation
<!-- Short summary of the documentation that should be added -->

### Tasks
<!--Add GitHub tasks-->
- [ ] ...
- [ ] ...

### Acceptance Criteria
<!-- Acceptance Criteria helps to answer the question "How will I know when I'm done with this story?". It defines the requirements that must be met for the story to be completed. See https://www.ssw.com.au/rules/acceptance-criteria -->
- [ ] Meets Definition of Done - {{ LINK }}
- [ ] ...

### More Information
<!-- Add any other context here -->

### Screenshots
<!-- If applicable, add screenshots to help explain your problem. -->

Thanks!
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/3-refactor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: "♻️ Refactor"
about: 'Something that needs improving while not changing functionality as per https://www.ssw.com.au/rules/technical-debt/'
title: "♻️"
labels: 'Type: Refactor'
assignees: ''

---
<!-- These comments automatically delete -->
<!-- **Tip:** Delete parts that are not relevant -->
<!-- Next to Cc:, @ mention users who should be in the loop -->
Cc:
<!-- add intended user next to **Hi** -->
Hi

### Pain
<!-- Explain the pain you are experiencing -->

### What code could be improved?
<!-- Add a link to the area/file that needs refactoring -->

### Tasks
<!--Add GitHub tasks-->
- [ ] ...
- [ ] ...

### Acceptance Criteria
<!-- Acceptance Criteria helps to answer the question "How will I know when I'm done with this story?". It defines the requirements that must be met for the story to be completed. See https://www.ssw.com.au/rules/acceptance-criteria -->
- [ ] Meets Definition of Done - {{ LINK }}
- [ ] ...

### More Information
<!-- Add any other context here. -->

### Screenshots
<!-- If applicable, add screenshots to help explain your problem. -->

Thanks!
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/4-devops.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
name: "👷 DevOps"
about: CI/CD and other DevOps concerns e.g. Updating the build, code analysis, test, deploy, application monitoring etc.
title: "👷"
labels: 'Type: DevOps'
assignees: ''

---

<!-- These comments automatically delete -->
<!-- **Tip:** Delete parts that are not relevant -->
<!-- Next to Cc:, @ mention users who should be in the loop -->
Cc:
<!-- add intended user next to **Hi** -->
Hi

### Pain
<!-- Explain the pain you are experiencing -->

### Suggested Solution
<!-- Describe the solution you'd like -->

### Tasks
<!--Add GitHub tasks-->
- [ ] ...
- [ ] ...

### Acceptance Criteria
<!-- Acceptance Criteria helps to answer the question "How will I know when I'm done with this story?". It defines the requirements that must be met for the story to be completed. See https://www.ssw.com.au/rules/acceptance-criteria -->
- [ ] Meets Definition of Done - {{ LINK }}
- [ ] ...

### More Information
<!-- Add any other context here. -->

### Screenshots
<!-- If applicable, add screenshots to help explain your problem. -->

Thanks!

0 comments on commit 519056a

Please sign in to comment.