Просмотр исходного кода

Merge pull request #1134 from PrivateBin/better-issue-templates

Update and create new issue templates for better catgeorisation
El RIDO 3 лет назад
Родитель
Сommit
771d7a3df8

+ 62 - 0
.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

+ 14 - 3
.github/ISSUE_TEMPLATE.md → .github/ISSUE_TEMPLATE/bug_report.md

@@ -1,5 +1,16 @@
-<!-- Please have a look at our FAQ before submitting an issue: https://github.com/PrivateBin/PrivateBin/wiki/FAQ -->
-<!-- This is a template for a bug report. If you would like to suggest a feature, feel free to delete the part below. -->
+---
+name: Bug report
+about: Create a report to help us improve (only for software bugs)
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+<!-- Please make sure to **only** use this template when it is about bugs in the PrivateBin PHP project.
+Otherwise, for help and support issues e.g. for deployment issues, please go back and chose the appropiate category. -->
+
+<-- Describe the bug: A clear and concise description of what the bug is. -->
 
 ## Steps to reproduce
 <!-- Tell us how to reproduce the problem. -->
@@ -26,7 +37,7 @@ If you have access to the server log files, also copy them here.
 <!-- The Operation System of your server -->
 **Server OS:**
 
-<!-- The webserver running on your server, preferrably including the version -->
+<!-- The webserver running on your server, preferably including the version -->
 **Webserver:**
 
 <!-- The version of your browser (when it is a client-side issue) -->

+ 13 - 0
.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.
+

+ 22 - 0
.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
+<!-- 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. -->