Skip to content

Commit 80a24f6

Browse files
committedJul 22, 2024··
feat(template): github issue templates
1 parent bf035d5 commit 80a24f6

File tree

3 files changed

+86
-0
lines changed

3 files changed

+86
-0
lines changed
 

‎.github/ISSUE_TEMPLATE/bug_report.yml

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# This template is heavily inspired by the acme-corp and shadcn-ui/ui repositories.
2+
# See: https://github.com/juliusmarminge/acme-corp/blob/main/.github/ISSUE_TEMPLATE/bug_report.yml
3+
# See: https://github.com/shadcn-ui/ui/blob/main/.github/ISSUE_TEMPLATE/feature_request.yml
4+
5+
name: Bug report
6+
description: Create a bug report to help us improve
7+
title: "[bug]: "
8+
labels: ["🐞❔ unconfirmed bug"]
9+
body:
10+
- type: textarea
11+
attributes:
12+
label: Describe the bug
13+
description: A clear and concise description of the bug, as well as what you expected to happen when encountering it.
14+
validations:
15+
required: true
16+
- type: textarea
17+
attributes:
18+
label: How to reproduce
19+
description: A step-by-step description of how to reproduce the bug.
20+
placeholder: |
21+
1. Go to '...'
22+
2. Click on '....'
23+
3. See error
24+
validations:
25+
required: true
26+
- type: input
27+
attributes:
28+
label: Link to reproduction
29+
description: A link to a CodeSandbox or StackBlitz that includes a minimal reproduction of the problem. In rare cases when not applicable, you can link to a GitHub repository that we can easily run to recreate the issue. If a report is vague and does not have a reproduction, it will be closed without warning.
30+
validations:
31+
required: true
32+
- type: textarea
33+
attributes:
34+
label: Additional information
35+
description: Add any other information related to the bug here, screenshots if applicable.

‎.github/ISSUE_TEMPLATE/config.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# This template is heavily inspired by the shadcn-ui/ui repository.
2+
# See: https://github.com/shadcn-ui/ui/blob/main/.github/ISSUE_TEMPLATE/config.yml
3+
4+
blank_issues_enabled: false
5+
contact_links:
6+
- name: General questions
7+
url: https://github.com/JaleelB/emblor/discussions?category=general
8+
about: Please ask and answer questions here
+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# This template is heavily inspired by the shadcn-ui/ui repository.
2+
# See: https://github.com/shadcn-ui/ui/blob/main/.github/ISSUE_TEMPLATE/feature_request.yml
3+
4+
name: 'Feature request'
5+
description: Create a feature request for skateshop
6+
title: '[feat]: '
7+
labels: ['✨ enhancement']
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
### Thanks for suggesting a feature request! Make sure to see if your feature request has already been suggested by searching through the existing issues. If you find a similar request, give it a thumbs up and add any additional context you have in the comments.
13+
14+
- type: textarea
15+
id: feature-description
16+
attributes:
17+
label: Feature description
18+
description: Tell us about your feature request.
19+
placeholder: 'I think this feature would be great because...'
20+
value: 'Describe your feature request...'
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: context
26+
attributes:
27+
label: Additional Context
28+
description: Add any other context about the feature here.
29+
placeholder: ex. screenshots, Stack Overflow links, forum links, etc.
30+
value: 'Additional details here...'
31+
validations:
32+
required: false
33+
34+
- type: checkboxes
35+
id: terms
36+
attributes:
37+
label: Before submitting
38+
description: By submitting this issue, you agree to follow our [Contributing Guidelines](https://github.com/JaleelB/emblor/blob/main/CONTRIBUTING.md).
39+
options:
40+
- label: I've made research efforts and searched the documentation
41+
required: true
42+
- label: I've searched for existing issues and PRs
43+
required: true

0 commit comments

Comments
 (0)
Please sign in to comment.