Skip to content

Commit

Permalink
Improved issue templates with security policy (#217)
Browse files Browse the repository at this point in the history
* Update bug-report.yml
* Update support-question.yml
* Create feature-request.yml
* Create security.md
  • Loading branch information
prince-chrismc authored Mar 14, 2022
1 parent 9d1a010 commit af50274
Show file tree
Hide file tree
Showing 6 changed files with 143 additions and 78 deletions.
82 changes: 82 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
name: Bug Report 🐛
description: File a bug report

labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
validations:
required: false
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen? Feel free to include some screenshots
placeholder: Tell us what you see!
value: "A bug happened!"
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: How To Reproduce?
description: Please provide a small snippet to reproduce the issue
placeholder: Some C++ code or Shell code to recreate th problem
value: |
```c++
#include "jwt-cpp/jwt.h"
int main() {
return 0;
}
```
- type: dropdown
id: version
attributes:
label: Version
description: What version of our software are you running?
options:
- 0.6.0
- 0.5.2
- Older (please let us know if the "What happened" box)
validations:
required: true
- type: dropdown
id: operating-system
attributes:
label: What OS are you seeing the problem on?
multiple: true
options:
- Windows
- Linux
- MacOS
- Other (please let us know if the "What happened" box)
validations:
required: true
- type: dropdown
id: compiler
attributes:
label: What compiler are you seeing the problem on?
multiple: true
options:
- GCC
- Clang
- MSVC
- Other (please let us know if the "What happened" box)
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
options:
- label: I agree to follow this project's Code of Conduct
required: true
42 changes: 0 additions & 42 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Feature Request 🧪
description: Have a great idea? Find something is missing?
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
We'd love to hear your idea(s)!
- type: input
id: question
attributes:
label: "What would you like to see added?"
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional Context
validations:
required: true
36 changes: 0 additions & 36 deletions .github/ISSUE_TEMPLATE/support-question.md

This file was deleted.

20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/support-question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Support Question 🤹
description: Have some questions? We can offer help.
labels: ["question"]
body:
- type: markdown
attributes:
value: |
Don't hesitate to ask any question you might have!
- type: input
id: question
attributes:
label: "What's your question?"
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional Context
validations:
required: true
21 changes: 21 additions & 0 deletions .github/security.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Reporting Security Issues

If you believe you have found a security vulnerability in JWT-CPP, we encourage you to let us know right away.
We will investigate all legitimate reports and do our best to quickly fix the problem.

Please refer to the section below for our responsible disclosure policy:

## Disclosure Policy

Please contact one or more of the maintainers using the email advertised on our GitHub profiles:

- [@Thalhammer](https://github.com/Thalhammer)
- [@prince-chrismc](https://github.com/prince-chrismc)

Please provide as many details as possible about version, platform, and workflow as possible.
Having steps and reproducible code is better and is always greatly appreciated.

## Supported Version

Typically, fixes will be immediately released as a new patch release. However, older affected versions may receive
a new patch upon request.

0 comments on commit af50274

Please sign in to comment.