From 1a37f7b865e5f51a9dfac023a3663256dd7ca268 Mon Sep 17 00:00:00 2001 From: rugk Date: Mon, 7 Aug 2023 19:24:13 +0200 Subject: [PATCH] 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