From 21d3ed69ef1a622b131816098a68e0866c27f216 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Chalet?= <kevinchalet@gmail.com> Date: Sun, 8 Nov 2020 20:09:14 +0100 Subject: [PATCH] Add issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 24 ++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++++++++ .github/ISSUE_TEMPLATE/enhancement.md | 15 +++++++++++++++ .github/ISSUE_TEMPLATE/question.md | 5 +++++ README.md | 8 +++++++- SECURITY.md | 6 ++++++ 6 files changed, 65 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/enhancement.md create mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 SECURITY.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..df8e485 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,24 @@ +--- +name: Report a bug +about: Create a report about something that is not working properly +labels: bug +--- + +### Describe the bug +A clear and concise description of what the bug is. + +### To reproduce +<!-- +We ❤ code! Ideally, please point us to a minimalistic repro project hosted in a GitHub repository. +For a repro project, create a new project and apply the minimum required code to result in the issue you're observing. +--> + +### Exceptions (if any) +<!-- +Include the exception you get when facing this issue. +--> + +### Further technical details +- ASP.NET Core version. +- Include the output of `dotnet --info`. +- The IDE (VS / VS Code/ VS4Mac) you're running on, and its version. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..700c563 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: true +contact_links: + - name: Sponsor the project + url: https://github.com/sponsors/kevinchalet + about: In recognition of their support, sponsors can get private support and depending on the selected tier, an access to security announcements and patches + - name: Ask a question (community support) + url: https://stackoverflow.com/questions/ask?tags=openiddict + about: Ask a question that will be answered by the OpenIddict community \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md new file mode 100644 index 0000000..2745584 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -0,0 +1,15 @@ +--- +name: Suggest an enhancement +about: "Suggest an idea for this project. Note: priority will be given to suggestions made by sponsors" +labels: enhancement +--- + +### Is your feature request related to a problem? +A clear and concise description of what the problem is. +Example: I am trying to do [...] but [...]. + +### Describe the solution you'd like +A clear and concise description of what you want to happen. Include any alternative solutions you've considered. + +### Additional context +Add any other context or screenshots about the feature request here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..812b8a4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,5 @@ +--- +name: Ask a question or request support (sponsors-only) +about: "Important: only sponsors can ask a question on GitHub. If you're not a sponsor, please post your question on StackOverflow" +labels: question +--- \ No newline at end of file diff --git a/README.md b/README.md index 15d1ed5..62f2a99 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,15 @@ This repository provides the documentation for the [OpenIddict](https://github.com/openiddict) project. +## Security policy + +Security issues and bugs should be reported privately by emailing contact@kevinchalet.com. +You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. + ## Support -**Need help or wanna share your thoughts?** Don't hesitate to join us on Gitter or ask your question on StackOverflow: +If you need support, please make sure you [sponsor the project](https://github.com/sponsors/kevinchalet) before creating a GitHub ticket. +If you're not a sponsor, you can post your questions on Gitter or StackOverflow: - **Gitter: [https://gitter.im/openiddict/openiddict-core](https://gitter.im/openiddict/openiddict-core)** - **StackOverflow: [https://stackoverflow.com/questions/tagged/openiddict](https://stackoverflow.com/questions/tagged/openiddict)** diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..6eec299 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,6 @@ +# Security policy + +Security issues and bugs should be reported privately by emailing contact@kevinchalet.com. +You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. + +Please do not open GitHub issues for anything you think might have a security implication. \ No newline at end of file