Skip to content

Commit 7d89412

Browse files
authored
Merge pull request #193 from crazy-max/form-templates
chore: github form templates
2 parents d4e5c01 + 2d73326 commit 7d89412

File tree

4 files changed

+122
-33
lines changed

4 files changed

+122
-33
lines changed

.github/ISSUE_TEMPLATE/bug.yml

+101
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
2+
name: Bug Report
3+
description: Report a bug
4+
labels:
5+
- kind/bug
6+
- status/triage
7+
8+
body:
9+
- type: checkboxes
10+
attributes:
11+
label: Support guidelines
12+
description: Please read the support guidelines before proceeding.
13+
options:
14+
- label: I've read the [support guidelines](https://github.com/crazy-max/ghaction-github-labeler/blob/master/.github/SUPPORT.md)
15+
required: true
16+
17+
- type: checkboxes
18+
attributes:
19+
label: I've found a bug and checked that ...
20+
description: |
21+
Make sure that your request fulfills all of the following requirements. If one requirement cannot be satisfied, explain in detail why.
22+
options:
23+
- label: ... the documentation does not mention anything about my problem
24+
- label: ... there are no open or closed issues that are related to my problem
25+
26+
- type: textarea
27+
attributes:
28+
label: Description
29+
description: |
30+
Please provide a brief description of the bug in 1-2 sentences.
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
attributes:
36+
label: Expected behaviour
37+
description: |
38+
Please describe precisely what you'd expect to happen.
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
attributes:
44+
label: Actual behaviour
45+
description: |
46+
Please describe precisely what is actually happening.
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
attributes:
52+
label: Steps to reproduce
53+
description: |
54+
Please describe the steps to reproduce the bug.
55+
placeholder: |
56+
1. ...
57+
2. ...
58+
3. ...
59+
validations:
60+
required: true
61+
62+
- type: input
63+
attributes:
64+
label: Repository URL
65+
description: >
66+
Enter the URL of the repository where you are experiencing the
67+
issue. If your repository is private, provide a link to a minimal
68+
repository that reproduces the issue.
69+
validations:
70+
required: true
71+
72+
- type: input
73+
attributes:
74+
label: Workflow run URL
75+
description: >
76+
Enter the URL of the GitHub Action workflow run that fails (e.g.
77+
`https://github.com/<user>/<repo>/actions/runs/<id>`)
78+
79+
- type: textarea
80+
attributes:
81+
label: YAML workflow
82+
description: |
83+
Provide the YAML of the workflow that's causing the issue.
84+
Make sure to remove any sensitive information.
85+
render: yaml
86+
validations:
87+
required: true
88+
89+
- type: textarea
90+
attributes:
91+
label: Workflow logs
92+
description: >
93+
[Attach](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/attaching-files)
94+
the [log file of your workflow run](https://docs.github.com/en/actions/managing-workflow-runs/using-workflow-run-logs#downloading-logs)
95+
and make sure to remove any sensitive information.
96+
97+
- type: textarea
98+
attributes:
99+
label: Additional info
100+
description: |
101+
Please provide any additional information that seem useful.

.github/ISSUE_TEMPLATE/bug_report.md

-33
This file was deleted.

.github/ISSUE_TEMPLATE/config.yml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
2+
blank_issues_enabled: true
3+
contact_links:
4+
- name: Questions and Discussions
5+
url: https://github.com/crazy-max/ghaction-github-labeler/discussions/new
6+
about: Use Github Discussions to ask questions and/or open discussion topics.

.github/ISSUE_TEMPLATE/feature.yml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
2+
name: Feature request
3+
description: Missing functionality? Come tell us about it!
4+
labels:
5+
- kind/enhancement
6+
- status/triage
7+
8+
body:
9+
- type: textarea
10+
id: description
11+
attributes:
12+
label: Description
13+
description: What is the feature you want to see?
14+
validations:
15+
required: true

0 commit comments

Comments
 (0)