Skip to content

Commit 44e65ef

Browse files
authored
Merge pull request #344 from kenjis/add-issue-template
chore: add issue templete
2 parents 336e2b5 + 4580d2a commit 44e65ef

File tree

4 files changed

+155
-0
lines changed

4 files changed

+155
-0
lines changed
Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
name: Bug report
2+
description: Create a report to help us improve CodeIgniter Shield
3+
title: "Bug: "
4+
labels: ['bug']
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out this bug report!
11+
12+
Before you begin, **please ensure that there are no existing issues,
13+
whether still open or closed, related to your report**.
14+
If there is, your report will be closed promptly.
15+
16+
For example, if you get the error "*Can't find a route for 'post: login'*",
17+
you can search the GitHub repository with the keyword "[Can't find a route for](https://github.com/codeigniter4/shield/issues?q=Can%27t+find+a+route+for)".
18+
19+
---
20+
21+
- type: input
22+
id: php-version
23+
attributes:
24+
label: PHP Version
25+
description: |
26+
e.g. 8.1.8
27+
validations:
28+
required: true
29+
30+
- type: input
31+
id: codeigniter-version
32+
attributes:
33+
label: CodeIgniter4 Version
34+
description: |
35+
e.g. 4.2.2
36+
validations:
37+
required: true
38+
39+
- type: input
40+
id: shield-version
41+
attributes:
42+
label: Shield Version
43+
description: |
44+
e.g. 1.0.0-beta.2
45+
If you are not using the [latest version](https://github.com/codeigniter4/shield/releases), please
46+
check to see if the problem occurs with the latest version.
47+
validations:
48+
required: true
49+
50+
- type: dropdown
51+
id: operating-systems
52+
attributes:
53+
label: Which operating systems have you tested for this bug?
54+
description: You may select more than one.
55+
multiple: true
56+
options:
57+
- macOS
58+
- Windows
59+
- Linux
60+
validations:
61+
required: true
62+
63+
- type: dropdown
64+
id: server
65+
attributes:
66+
label: Which server did you use?
67+
options:
68+
- apache
69+
- cli
70+
- cli-server (PHP built-in webserver)
71+
- cgi-fcgi
72+
- fpm-fcgi
73+
- phpdbg
74+
validations:
75+
required: true
76+
77+
- type: input
78+
id: database
79+
attributes:
80+
label: Database
81+
description: e.g. MySQL 5.6, MariaDB 10.2, PostgreSQL 9.6
82+
validations:
83+
required: true
84+
85+
- type: textarea
86+
id: shield-customization
87+
attributes:
88+
label: Did you customize Shield?
89+
description: |
90+
If "Yes," please tell us which classes you customized and how.
91+
If "No," please indicate "No."
92+
validations:
93+
required: true
94+
95+
- type: textarea
96+
id: description
97+
attributes:
98+
label: What happened?
99+
placeholder: Tell us what you see!
100+
validations:
101+
required: true
102+
103+
- type: textarea
104+
attributes:
105+
label: Steps to Reproduce
106+
description: Steps to reproduce the behavior.
107+
validations:
108+
required: true
109+
110+
- type: textarea
111+
attributes:
112+
label: Expected Output
113+
description: What do you expect to happen instead of this filed bug?
114+
validations:
115+
required: true
116+
117+
- type: textarea
118+
attributes:
119+
label: Anything else?
120+
description: |
121+
Links? References? Anything that will give us more context about the issue you are encountering!
122+
123+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
124+
validations:
125+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: GitHub Discussions
4+
url: https://github.com/codeigniter4/shield/discussions
5+
about: Please ask your support questions in the Discussions. Thanks!
6+
7+
- name: CodeIgniter Slack channel
8+
url: https://codeigniterchat.slack.com
9+
about: Engage with other members of the community in our Slack channel.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
name: Feature request
3+
about: How to submit a feature request
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
Please submit feature requests to [Discussions](https://github.com/codeigniter4/shield/discussions/categories/ideas).
11+
We use GitHub Issues to track bugs and planned work.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Planned work
3+
about: Approved work planning
4+
title: 'Dev: '
5+
labels: dev
6+
assignees: ''
7+
8+
---
9+
10+
Repo maintainers will create "issues" for planned work, so it can be tracked.

0 commit comments

Comments
 (0)