Skip to content

Commit

Permalink
chore: add ISSUE_TEMPLATES to the github repository (#28)
Browse files Browse the repository at this point in the history
* chore: add bug report template

* chore: add issue template config

* chore: upgrade bug report ISSUE_TEMPLATE

* chore: more changes to the bug report ISSUE_TEMPLATE

* chore: add feature request ISSUE_TEMPLATE
  • Loading branch information
SeanCassiere authored Sep 15, 2023
1 parent b2a02c3 commit 53ce99d
Show file tree
Hide file tree
Showing 3 changed files with 138 additions and 0 deletions.
85 changes: 85 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
name: "🐛 Bug report"
description: Create a report to help us improve simple-logging-server.
title: "fix: "
labels:
- "bug"

body:
- type: markdown
attributes:
value: |
**Thank you for finding and reporting this issue :pray:!**
We kindly ask that you search to see if an issue [already exists](https://github.com/SeanCassiere/simple-logging-server/issues?q=is%3Aissue+sort%3Acreated-desc+) for your bug.
We are also happy to accept contributions from our users. For more details see [here](https://github.com/SeanCassiere/simple-logging-server/blob/master/CONTRIBUTION.md).
- type: textarea
id: description
attributes:
label: Describe the bug
description: Provide a clear and concise description of the challenge you are running into.
validations:
required: true

- type: input
id: link
attributes:
label: Your Example Website or App
description: |
An example of the bug you are currently experiencing.
Note:
- To create a shareable code example using Stackblitz or a hosted Github repository. Please no localhost URLs.
- Please read these tips for providing a minimal example: https://stackoverflow.com/help/mcve.
placeholder: Reproduction URL/Repo
validations:
required: false

- type: textarea
id: steps
attributes:
label: Steps to Reproduce the Bug or Issue
description: Describe the steps needed to reproduce the behavior.
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected behavior
description: Provide a clear and concise description of what you expected to happen.
placeholder: |
As a user, I expected ___ behavior but i am seeing ___
validations:
required: true

- type: textarea
id: screenshots_or_videos
attributes:
label: Screenshots or Videos
description: |
If applicable, add screenshots or a video to help explain your problem.
For more information on the supported file image/file types and the file size limits, please refer
to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files
placeholder: |
You can drag your video or image files inside of this editor ↓
- type: textarea
id: platform
attributes:
label: Platform
value: |
- OS: [e.g. macOS, Windows, Linux]
- Node Version: [e.g. 18.7.1, 20.0.0]
validations:
required: true

- type: textarea
id: additional
attributes:
label: Additional context
description: Add any other context about the problem here.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Twitter
url: https://twitter.com/SeanCassiere
about: Please ask and answer questions here.
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: "🛠️ Feature Request"
description: Suggest an idea or feature to improve simple-logging-server.
title: "feat: "
labels:
- "enhancement"

body:
- type: markdown
attributes:
value: |
**Thanks :heart: for taking the time to fill out this feature request report!**
We kindly ask that you search to see if an issue [already exists](https://github.com/SeanCassiere/simple-logging-server/issues?q=is%3Aissue+sort%3Acreated-desc+) for your feature.
We are also happy to accept contributions from our users. For more details see [here](https://github.com/SeanCassiere/simple-logging-server/blob/master/CONTRIBUTION.md).
- type: textarea
attributes:
label: Description
description: |
A clear and concise description of the feature you're interested in.
validations:
required: true

- type: textarea
attributes:
label: Suggested Solution
description: |
Describe the solution you'd like. A clear and concise description of what you want to happen.
Also, include the acceptance criteria for the feature.
validations:
required: true

- type: textarea
attributes:
label: Alternatives
description: |
Describe alternatives you've considered.
A clear and concise description of any alternative solutions or features you've considered.
validations:
required: false

- type: textarea
attributes:
label: Additional Context
description: |
Add any other context about the problem here.
validations:
required: false

0 comments on commit 53ce99d

Please sign in to comment.