diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..a44c6281 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 52688815..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "[bug] Brief Description" -labels: '' -assignees: '' - ---- - - - -**Describe the bug** -A clear and concise description of what the bug is. - -**How To Reproduce** (Include if Applicable) -Please provide a small snippet to reproduce the issue - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Compiler [e.g. msvc, gcc] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. - -**Logs** (Include/Attach if Applicable) -
Click to expand log - -``` -Put your log output here -``` - -
diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 00000000..1912553f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/support-question.md b/.github/ISSUE_TEMPLATE/support-question.md deleted file mode 100644 index fb5d1b57..00000000 --- a/.github/ISSUE_TEMPLATE/support-question.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -name: Support Question -about: Have some questions? We can offer help. -title: "[question] Brief Description" -labels: question -assignees: '' - ---- - - - -**Describe the impediment** -A clear and concise description of what the challenge is. - -**Trying to obtain** -The code implementation which needs attention. - -**Desktop (please complete the following information):** (Include/Attach if Applicable) - - OS: [e.g. iOS] - - Compiler [e.g. msvc, gcc] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. - -**Logs** (Include/Attach if Applicable) -
Click to expand log - -``` -Put your log output here -``` - -
diff --git a/.github/ISSUE_TEMPLATE/support-question.yml b/.github/ISSUE_TEMPLATE/support-question.yml new file mode 100644 index 00000000..13912c03 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/support-question.yml @@ -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 diff --git a/.github/security.md b/.github/security.md new file mode 100644 index 00000000..76800013 --- /dev/null +++ b/.github/security.md @@ -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.