From 1a37f7b865e5f51a9dfac023a3663256dd7ca268 Mon Sep 17 00:00:00 2001 From: rugk Date: Mon, 7 Aug 2023 19:24:13 +0200 Subject: [PATCH 1/4] Update and create new issue templates for better ctageorisation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit [128 of 600 issues are just questions and support and this is getting out of hand IMHO](https://github.com/PrivateBin/PrivateBin/issues?q=is%3Aissue+is%3Aopen+label%3Aquestion%2Fsupport), so I thought we need to do something while of course IMHO keeping support in some sense that is vital to an open-source project. Anyway, this here now: * Converts the "one and only issue template" to multiple ones with the new GitHub way, see https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/ Note this uses mostly the templates they have, modifies them to use proper headers (sorry but I don't get why they always want to use **bold text** as headers, when you have real markdown headings) and adjusts/ports the * We could use even more elaborate issue forms, but that was too much for me to do now and is also beta, so maybe when they have a visual editor for that or so 😉 https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms The aim: * is to get support requests and stuff directly sorted and tagged, so they are out the way * is to nudge people to improve the quality of issues/reports by providing a more useful template or their use case * is to redirect people to the appropriate resource (give me a moment) --- .github/ISSUE_TEMPLATE/bug_report.md | 46 +++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 22 ++++++++ .../ISSUE_TEMPLATE/question-and-support.md | 50 +++++++++++++++++++ 3 files changed, 118 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question-and-support.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..0541a10f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,46 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +<-- Describe the bug: A clear and concise description of what the bug is. --> + +## Steps to reproduce + +1. +2. + +### What happens + + +### What should happen + + +## Additional information + + +## Basic information + + +**Server address**: + + +**Server OS:** + + +**Webserver:** + + +**Browser:** + + +**PrivateBin version:** + +I can reproduce this issue on : Yes / No diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..b12823f0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,22 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +## The problem + +<-- Is your feature request related to a problem? Please describe. +A clear and concise description of what the problem is. Ex. I'm always frustrated when --> + +## The solution +<-- A clear and concise description of what you want to happen. Pitch your solution! What would happen, if we don't implement this? --> + +## Alternatives + + +## Additional context + diff --git a/.github/ISSUE_TEMPLATE/question-and-support.md b/.github/ISSUE_TEMPLATE/question-and-support.md new file mode 100644 index 00000000..973deadf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question-and-support.md @@ -0,0 +1,50 @@ +--- +name: Question and support +about: Your setup is not working and you need help or you have a question regarding + PrivateBin +title: '' +labels: question/support +assignees: '' + +--- + +<-- Describe the problem/question: A clear and concise description of what the bug is. --> + + +* [ ] Yes I have read [the FAQ](https://github.com/PrivateBin/PrivateBin/wiki/FAQ) and I found no solution/answer there. + +## What you did + +1. +2. + +### What happens + + +### What should happen + + +## Additional information + + +## Basic information + + +**Server address**: + + +**Server OS:** + + +**Webserver:** + + +**Browser:** + + +**PrivateBin version:** + +I can reproduce this issue on : Yes / No From 8deb68c2daddad7466f3301c381da937e9e3ddab Mon Sep 17 00:00:00 2001 From: rugk Date: Mon, 7 Aug 2023 17:26:26 +0000 Subject: [PATCH 2/4] chore: remove old issue template --- .github/ISSUE_TEMPLATE.md | 38 -------------------------------------- 1 file changed, 38 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 55fbca68..00000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,38 +0,0 @@ - - - -## Steps to reproduce - -1. -2. - -### What happens - - -### What should happen - - -## Additional information - - -## Basic information - - -**Server address**: - - -**Server OS:** - - -**Webserver:** - - -**Browser:** - - -**PrivateBin version:** - -I can reproduce this issue on : Yes / No From 204d1756c97138e3abc470d8d49f954f0cfaeb41 Mon Sep 17 00:00:00 2001 From: rugk Date: Mon, 7 Aug 2023 17:56:38 +0000 Subject: [PATCH 3/4] refactor: redirect support questions to discussions including form + more links Discussions apparently onyl support forms see, so I quickly used ChatGPT to convert the Markdown file into the YAMl format and after telling the format it seems to have done that in a good eay: https://chat.openai.com/share/99718495-28d0-4382-ab5e-6a4a733c1ccb (maybe GitHub introduced that after end of 2021 hehe, so the LLM could not know that) --- .github/DISCUSSION_TEMPLATE/q-a.yml | 62 +++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 5 +- .github/ISSUE_TEMPLATE/config.yml | 13 ++++ .../ISSUE_TEMPLATE/question-and-support.md | 50 --------------- 4 files changed, 79 insertions(+), 51 deletions(-) create mode 100644 .github/DISCUSSION_TEMPLATE/q-a.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/question-and-support.md diff --git a/.github/DISCUSSION_TEMPLATE/q-a.yml b/.github/DISCUSSION_TEMPLATE/q-a.yml new file mode 100644 index 00000000..cf02916f --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/q-a.yml @@ -0,0 +1,62 @@ +title: "[Question and support] " +labels: ["question/support"] +body: + - type: markdown + attributes: + value: | + Describe the problem/question: A clear and concise description of what the problem/issue or question is. + - type: checkboxes + attributes: + label: Please tick this to confirm + options: + - label: Yes, I have read [the FAQ](https://github.com/PrivateBin/PrivateBin/wiki/FAQ) and I found no solution/answer there. + - type: markdown + attributes: + value: | + ## What you did + Tell us how to reproduce the problem. + + 1. + 2. + - type: textarea + id: what_happens + attributes: + label: What happens + - type: textarea + id: what_should_happen + attributes: + label: What should happen + - type: textarea + id: additional_info + attributes: + label: Additional information + description: If you have access to the server log files, copy them here. + - type: input + id: server_address + attributes: + label: Server address + - type: input + id: server_os + attributes: + label: Server OS + - type: input + id: webserver + attributes: + label: Webserver + - type: input + id: browser + attributes: + label: Browser + - type: input + id: privatebin_version + attributes: + label: PrivateBin version + - type: radio + id: reproduce_issue + attributes: + label: I can reproduce this issue on [https://privatebin.net](https://privatebin.net) + options: + - label: Yes + value: Yes + - label: No + value: No diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 0541a10f..9a02c084 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,12 +1,15 @@ --- name: Bug report -about: Create a report to help us improve +about: Create a report to help us improve (only for software bugs) title: '' labels: bug assignees: '' --- + + <-- Describe the bug: A clear and concise description of what the bug is. --> ## Steps to reproduce diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..2df8210a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,13 @@ +blank_issues_enabled: false +contact_links: + - name: Question and support + url: https://github.com/orgs/PrivateBin/discussions/new?category=q-a + about: Your setup is not working and you need help or you have a question regarding + PrivateBin + - name: Problem with the container image + url: https://github.com/PrivateBin/docker-nginx-fpm-alpine/issues/new + about: Please report all problems that apply **only** to the official (Docker) image `docker-nginx-fpm-alpine` here. + - name: Security issue + url: https://github.com/PrivateBin/PrivateBin/security/policy + about: Please report security vulnerabilities and other security issues here. + diff --git a/.github/ISSUE_TEMPLATE/question-and-support.md b/.github/ISSUE_TEMPLATE/question-and-support.md deleted file mode 100644 index 973deadf..00000000 --- a/.github/ISSUE_TEMPLATE/question-and-support.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -name: Question and support -about: Your setup is not working and you need help or you have a question regarding - PrivateBin -title: '' -labels: question/support -assignees: '' - ---- - -<-- Describe the problem/question: A clear and concise description of what the bug is. --> - - -* [ ] Yes I have read [the FAQ](https://github.com/PrivateBin/PrivateBin/wiki/FAQ) and I found no solution/answer there. - -## What you did - -1. -2. - -### What happens - - -### What should happen - - -## Additional information - - -## Basic information - - -**Server address**: - - -**Server OS:** - - -**Webserver:** - - -**Browser:** - - -**PrivateBin version:** - -I can reproduce this issue on : Yes / No From a22b96b7fc94d31a381d6d4556ff8ba60f9a9bd1 Mon Sep 17 00:00:00 2001 From: rugk Date: Mon, 7 Aug 2023 20:02:36 +0200 Subject: [PATCH 4/4] style: fix typo --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 9a02c084..c43420c6 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,7 +7,7 @@ assignees: '' --- - <-- Describe the bug: A clear and concise description of what the bug is. -->