Skip to content

Commit

Permalink
docs: add issues/PRs templates
Browse files Browse the repository at this point in the history
  • Loading branch information
theoludwig committed Nov 21, 2023
1 parent ee4abf9 commit f037df5
Show file tree
Hide file tree
Showing 6 changed files with 93 additions and 0 deletions.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: "🐛 Bug Report"
about: "Report an unexpected problem or unintended behavior."
title: "[Bug]"
labels: "bug"
---

<!--
Please provide a clear and concise description of what the bug is. Include
screenshots if needed. Please make sure your issue has not already been fixed.
-->

## Steps To Reproduce

1. Step 1
2. Step 2

## The current behavior

## The expected behavior
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/DOCUMENTATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: "📜 Documentation"
about: "Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...)."
title: "[Documentation]"
labels: "documentation"
---

<!-- Please make sure your issue has not already been fixed. -->

## Documentation

<!-- Please uncomment the type of documentation problem this issue address -->

<!-- Documentation is Missing -->
<!-- Documentation is Confusing -->
<!-- Documentation has Typo errors -->

## Proposal
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: "✨ Feature Request"
about: "Suggest a new feature idea."
title: "[Feature]"
labels: "feature request"
---

<!-- Please make sure your issue has not already been fixed. -->

## Description

<!-- A clear and concise description of the problem or missing capability... -->

## Describe the solution you'd like

<!-- If you have a solution in mind, please describe it. -->

## Describe alternatives you've considered

<!-- Have you considered any alternative solutions or workarounds? -->
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/IMPROVEMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: "🔧 Improvement"
about: "Improve structure/format/performance/refactor/tests of the code."
title: "[Improvement]"
labels: "improvement"
---

<!-- Please make sure your issue has not already been fixed. -->

## Type of Improvement

<!-- Please uncomment the type of improvements this issue address -->

<!-- Files and Folders Structure -->
<!-- Performance -->
<!-- Refactoring code -->
<!-- Tests -->
<!-- Not Sure? -->

## Proposal
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/QUESTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: "🙋 Question"
about: "Further information is requested."
title: "[Question]"
labels: "question"
---

### Question
7 changes: 7 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<!-- Please first discuss the change you wish to make via issue before making a change. It might avoid a waste of your time. -->

# What changes this PR introduce?

## List any relevant issue numbers

## Is there anything you'd like reviewers to focus on?

0 comments on commit f037df5

Please sign in to comment.