Skip to content

Commit af50274

Browse files
Improved issue templates with security policy (#217)
* Update bug-report.yml * Update support-question.yml * Create feature-request.yml * Create security.md
1 parent 9d1a010 commit af50274

File tree

6 files changed

+143
-78
lines changed

6 files changed

+143
-78
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
name: Bug Report 🐛
2+
description: File a bug report
3+
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
validations:
11+
required: false
12+
- type: textarea
13+
id: what-happened
14+
attributes:
15+
label: What happened?
16+
description: Also tell us, what did you expect to happen? Feel free to include some screenshots
17+
placeholder: Tell us what you see!
18+
value: "A bug happened!"
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: reproduce
23+
attributes:
24+
label: How To Reproduce?
25+
description: Please provide a small snippet to reproduce the issue
26+
placeholder: Some C++ code or Shell code to recreate th problem
27+
value: |
28+
```c++
29+
#include "jwt-cpp/jwt.h"
30+
int main() {
31+
return 0;
32+
}
33+
```
34+
- type: dropdown
35+
id: version
36+
attributes:
37+
label: Version
38+
description: What version of our software are you running?
39+
options:
40+
- 0.6.0
41+
- 0.5.2
42+
- Older (please let us know if the "What happened" box)
43+
validations:
44+
required: true
45+
- type: dropdown
46+
id: operating-system
47+
attributes:
48+
label: What OS are you seeing the problem on?
49+
multiple: true
50+
options:
51+
- Windows
52+
- Linux
53+
- MacOS
54+
- Other (please let us know if the "What happened" box)
55+
validations:
56+
required: true
57+
- type: dropdown
58+
id: compiler
59+
attributes:
60+
label: What compiler are you seeing the problem on?
61+
multiple: true
62+
options:
63+
- GCC
64+
- Clang
65+
- MSVC
66+
- Other (please let us know if the "What happened" box)
67+
validations:
68+
required: true
69+
- type: textarea
70+
id: logs
71+
attributes:
72+
label: Relevant log output
73+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
74+
render: shell
75+
- type: checkboxes
76+
id: terms
77+
attributes:
78+
label: Code of Conduct
79+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
80+
options:
81+
- label: I agree to follow this project's Code of Conduct
82+
required: true

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 42 deletions
This file was deleted.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Feature Request 🧪
2+
description: Have a great idea? Find something is missing?
3+
labels: ["enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
We'd love to hear your idea(s)!
9+
- type: input
10+
id: question
11+
attributes:
12+
label: "What would you like to see added?"
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: context
17+
attributes:
18+
label: Additional Context
19+
validations:
20+
required: true

.github/ISSUE_TEMPLATE/support-question.md

Lines changed: 0 additions & 36 deletions
This file was deleted.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Support Question 🤹
2+
description: Have some questions? We can offer help.
3+
labels: ["question"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Don't hesitate to ask any question you might have!
9+
- type: input
10+
id: question
11+
attributes:
12+
label: "What's your question?"
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: context
17+
attributes:
18+
label: Additional Context
19+
validations:
20+
required: true

.github/security.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Reporting Security Issues
2+
3+
If you believe you have found a security vulnerability in JWT-CPP, we encourage you to let us know right away.
4+
We will investigate all legitimate reports and do our best to quickly fix the problem.
5+
6+
Please refer to the section below for our responsible disclosure policy:
7+
8+
## Disclosure Policy
9+
10+
Please contact one or more of the maintainers using the email advertised on our GitHub profiles:
11+
12+
- [@Thalhammer](https://github.com/Thalhammer)
13+
- [@prince-chrismc](https://github.com/prince-chrismc)
14+
15+
Please provide as many details as possible about version, platform, and workflow as possible.
16+
Having steps and reproducible code is better and is always greatly appreciated.
17+
18+
## Supported Version
19+
20+
Typically, fixes will be immediately released as a new patch release. However, older affected versions may receive
21+
a new patch upon request.

0 commit comments

Comments
 (0)