From 545ae2fd93c2093d5cbf4caaafbfe3446fd90697 Mon Sep 17 00:00:00 2001 From: Paolo Asperti Date: Mon, 25 Jul 2022 23:00:38 +0200 Subject: [PATCH 1/3] Update issue templates --- .github/ISSUE_TEMPLATE/ask-a-question.md | 10 ++++++ .github/ISSUE_TEMPLATE/bug_report.md | 38 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++ 3 files changed, 68 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/ask-a-question.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/ask-a-question.md b/.github/ISSUE_TEMPLATE/ask-a-question.md new file mode 100644 index 0000000..1342ced --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ask-a-question.md @@ -0,0 +1,10 @@ +--- +name: Ask a question +about: Ask the community for help +title: '' +labels: question +assignees: '' + +--- + + diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..dd84ea7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**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] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**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 [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. From f6c5088aaddbbaf280b5a7339409cb0a72527e01 Mon Sep 17 00:00:00 2001 From: Paolo Asperti Date: Tue, 26 Jul 2022 22:53:09 +0200 Subject: [PATCH 2/3] new issue templates --- .github/ISSUE_TEMPLATE/ask-a-question.md | 5 ++- .github/ISSUE_TEMPLATE/bug_report.md | 37 ++++++++++------------- .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature_request.md | 9 ++++-- 4 files changed, 27 insertions(+), 25 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/ask-a-question.md b/.github/ISSUE_TEMPLATE/ask-a-question.md index 1342ced..ac6c876 100644 --- a/.github/ISSUE_TEMPLATE/ask-a-question.md +++ b/.github/ISSUE_TEMPLATE/ask-a-question.md @@ -2,9 +2,12 @@ name: Ask a question about: Ask the community for help title: '' -labels: question +labels: 'question' assignees: '' --- +This is the place for generic questions. Please stay on topic and be polite. +**Notes** + - Please write in english only. If you provide some images in different languages, you're required to write a translation in english. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dd84ea7..89f6da5 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -2,7 +2,7 @@ name: Bug report about: Create a report to help us improve title: '' -labels: '' +labels: 'bug' assignees: '' --- @@ -10,29 +10,24 @@ assignees: '' **Describe the bug** A clear and concise description of what the bug is. -**To Reproduce** +**Describe the environment** + - Install environment: docker, docker swarm, podman, kubernetes, or package + - If available, the `docker-compose.yaml` file + - If package, we need the distribution and release: Ubuntu 22.04, Debian 11, ... + - Or if you're running the plain binary, how you're running it + - In any case, you have to specify the version in use + +**How to Reproduce the bug** Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +1. Given the previously described environment +2. Do this and that +3. I get this error **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] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] +This should happen instead. **Additional context** Add any other context about the problem here. + +**Notes** + - Please write in english only. If you provide some images in different languages, you're required to write a translation in english. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7..34e4663 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -2,13 +2,13 @@ name: Feature request about: Suggest an idea for this project title: '' -labels: '' +labels: 'enhancement' assignees: '' --- **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 [...] +A clear and concise description of what the problem is. **Describe the solution you'd like** A clear and concise description of what you want to happen. @@ -17,4 +17,7 @@ A clear and concise description of what you want to happen. A clear and concise description of any alternative solutions or features you've considered. **Additional context** -Add any other context or screenshots about the feature request here. +Add any other context about the feature request here. + +**Notes** + - Please write in english only. If you provide some images in different languages, you're required to write a translation in english. From 6991b6eca06f76379572967f9eb8b4dcccab1112 Mon Sep 17 00:00:00 2001 From: Paolo Asperti Date: Tue, 26 Jul 2022 23:02:07 +0200 Subject: [PATCH 3/3] a note about the private key --- .github/ISSUE_TEMPLATE/ask-a-question.md | 1 + .github/ISSUE_TEMPLATE/bug_report.md | 2 ++ .github/ISSUE_TEMPLATE/feature_request.md | 2 ++ 3 files changed, 5 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/ask-a-question.md b/.github/ISSUE_TEMPLATE/ask-a-question.md index ac6c876..fe22e5a 100644 --- a/.github/ISSUE_TEMPLATE/ask-a-question.md +++ b/.github/ISSUE_TEMPLATE/ask-a-question.md @@ -11,3 +11,4 @@ This is the place for generic questions. Please stay on topic and be polite. **Notes** - Please write in english only. If you provide some images in different languages, you're required to write a translation in english. + - In any case, **NEVER** put here the content if your `id_ed25519` file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 89f6da5..145f7ef 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -31,3 +31,5 @@ Add any other context about the problem here. **Notes** - Please write in english only. If you provide some images in different languages, you're required to write a translation in english. + - In any case, **NEVER** put here the content if your `id_ed25519` file + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 34e4663..72ed15d 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -21,3 +21,5 @@ Add any other context about the feature request here. **Notes** - Please write in english only. If you provide some images in different languages, you're required to write a translation in english. + - In any case, **NEVER** put here the content if your `id_ed25519` file + \ No newline at end of file