Skip to content

Commit

Permalink
docs: add pr, bug report, feature request template
Browse files Browse the repository at this point in the history
  • Loading branch information
kilee1230 committed Jan 17, 2024
1 parent 761414d commit aa3258c
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''
---

## 🐛 Describe the bug

A clear and concise description of what the bug is

## 🗒 How to reproduce

Steps to reproduce the behavior

## 💃🏽 Expected behaviour

A clear and concise description of what you expected to happen

## ℹ️ Additional information

Any additional context that would help with the problem
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''
---

## 🤷🏽‍ Why

A clear and concise description of why the feature is needed or what the problem is

<!--- Why is this change important to you? How would you use it? -->
<!--- How can it benefit other users? -->

## 💡 Solution

A clear and concise description of what you want happen and how you want it to behave

<!--- Not obligatory, but suggest an idea for implementing addition or change -->

## 🍩 Alternatives

Describe any alternative solutions or features you have considered

<!--- Not obligatory, but shows that your request is considered and thought through -->
11 changes: 11 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## 🤷🏽‍ Reason for change

> _Statement(s) as to why this PR is needed, links to issues are okay. Keep them meaningful, clear and concise._
## 🔮 Proposed change(s)

> _Changes to the code and behaviour of the application_
>
> - bullet points outlining changes are nice
> - statements are nice too
> - again keep them meaningful, clear and concise

0 comments on commit aa3258c

Please sign in to comment.