Browse Source

Merge pull request #30778 from nextcloud/new-issue-template

Supercharge Issues template
Simon L 2 years ago
parent
commit
014ba75165
2 changed files with 226 additions and 166 deletions
  1. 226 0
      .github/ISSUE_TEMPLATE/BUG_REPORT.yml
  2. 0 166
      .github/ISSUE_TEMPLATE/Bug_report.md

+ 226 - 0
.github/ISSUE_TEMPLATE/BUG_REPORT.yml

@@ -0,0 +1,226 @@
+name: "Bug report: Nextcloud Server"
+description: "Submit a report and help us improve Nextcloud Server"
+title: "[Bug]: "
+labels: ["bug", "0. Needs triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ### 👍 Thank you for contributing to our project!
+        Please note this is a **free and open-source** project. You can obtain [Enterprise support](https://nextcloud.com/support/) if you run Nextcloud Server in a mission critical environment.
+  - type: checkboxes
+    id: before-posting
+    attributes:
+      label: "⚠️ Before submitting, please verify the following: ⚠️"
+      description: All conditions are **required**. Your issue can be closed if these are checked incorrectly.
+      options:
+        - label: This is a **bug**, not a question or a configuration issue.
+          required: true
+        - label: This issue is **not** already reported on Github (I've searched it).
+          required: true
+        - label: Nextcloud Server **is** up to date. See [Maintenance and Release Schedule](https://github.com/nextcloud/server/wiki/Maintenance-and-Release-Schedule) for supported versions.
+          required: true
+        - label: I agree to follow Nextcloud's [Code of Conduct](https://nextcloud.com/contribute/code-of-conduct/)
+          required: true
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Bug description
+      description: Provide a description of the bug you're experiencing.
+    validations:
+      required: true
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Steps to reproduce
+      description: Describe the steps to reproduce the bug.
+      value: |
+        1.
+        2.
+        3.
+        ...
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected behavior
+      description: Describe what you expected to happen.
+    validations:
+      required: true
+  - type: dropdown
+    id: install-method
+    attributes:
+      label: Installation method
+      description: |
+        Select installation method you used.
+        Describe the method in the "Additional info" section if you chose "other".
+      options:
+        - "Manual installation"
+        - "Official Docker image"
+        - "Official VM scripts"
+        - "Official SNAP package"
+        - "Official All-in-One appliance"
+        - "Web installer on a VPS or web space"
+        - "Other"
+    validations:
+      required: true
+  - type: dropdown
+    id: system
+    attributes:
+      label: Operating system
+      description: |
+        Select operating system where Nextcloud Server is installed.
+        Describe in the "Additional info" section if you chose "Other".
+      options:
+        - "Debian/Ubuntu"
+        - "RHEL/CentOS"
+        - "Other"
+    validations:
+      required: true
+  - type: dropdown
+    id: php
+    attributes:
+      label: PHP engine version
+      description: |
+        Select PHP engine version serving Nextcloud Server.
+        Describe in the "Additional info" section if you chose "Other".
+      options:
+        - "PHP 7.3"
+        - "PHP 7.4"
+        - "PHP 8.0"
+        - "PHP 8.1"
+        - "Other"
+    validations:
+      required: true
+  - type: dropdown
+    id: webserver
+    attributes:
+      label: Web server
+      description: |
+        Select Webserver serving Nextcloud Server.
+        Describe in the "Additional info" section if you chose "Other".
+      options:
+        - "Apache (supported)"
+        - "Nginx"
+        - "Lighttpd"
+        - "Other"
+    validations:
+      required: true
+  - type: dropdown
+    id: database
+    attributes:
+      label: Database engine version
+      description: |
+        Select Database engine serving Nextcloud Server.
+        Describe in the "Additional info" section if you chose "Other".
+      options:
+        - "MySQL"
+        - "MariaDB"
+        - "PostgreSQL"
+        - "SQlite"
+        - "Oracle"
+        - "Other"
+    validations:
+      required: true
+  - type: dropdown
+    id: fresh
+    attributes:
+      label: Is this bug present after an update or on a fresh install?
+      description: |
+        Select if bug is present after an update or on a fresh install.
+      options:
+        - "Updated from a minor version (ex. 22.2.3 to 22.2.4)"
+        - "Updated to a major version (ex. 22.2.3 to 23.0.1)"
+        - "Fresh Nextcloud Server install"
+    validations:
+      required: true
+  - type: dropdown
+    id: encryption
+    attributes:
+      label: Are you using the Nextcloud Server Encryption module?
+      description: |
+        Select if encryption is Enabled on your Nextcloud Server.
+      options:
+        - "Encryption is Enabled"
+        - "Encryption is Disabled"
+    validations:
+      required: true
+  - type: checkboxes
+    id: users
+    attributes:
+      label: Are you using an external user-backend?
+      description: |
+        Select all user-backends Enabled on your Nextcloud Server.
+        Describe in the "Additional info" section if you chose "Other".
+      options:
+      - label: "Default internal user-backend"
+      - label: "LDAP/ Active Directory"
+      - label: "SSO - SAML"
+      - label: "Other"
+    validations:
+      required: true
+  - type: textarea
+    id: configs
+    attributes:
+      label: Configuration report
+      description: |
+        Provide information about your configuration.
+        To get this information, execute one of the following commands on the CLI:
+        ```shell
+        sudo -u www-data php occ config:list system
+        php occ config:list system
+        ./occ config:list system
+        ```
+        > NOTE: This will be automatically formatted into code.
+      render: shell
+    validations:
+      required: true
+  - type: textarea
+    id: apps
+    attributes:
+      label: List of activated Apps
+      description: |
+        Provide information about your apps.
+        To get this information, execute one of the following commands on the CLI:
+        ```shell
+        sudo -u www-data php occ app:list
+        php occ app:list
+        ./occ app:list
+        ```
+        > NOTE: This will be automatically formatted into code.
+      render: shell
+    validations:
+      required: true
+  - type: textarea
+    id: nextcloud-signingstatus
+    attributes:
+      label: Nextcloud Signing status
+      description: |
+        Provide Nextcloud Signing status.
+        First, login as Admin user into your Nextcloud, then access this URL:
+        ```shell
+        https://yournextcloud.com/index.php/settings/integrity/failed 
+        ```
+        > NOTE: This will be automatically formatted into code.
+      render: shell
+    validations:
+      required: true
+  - type: textarea
+    id: nextcloud-log
+    attributes:
+      label: Nextcloud Logs
+      description: |
+        Provide Nextcloud logs lines.
+        Copy all contents from `data/nextcloud.log` or a RAW from `/settings/admin/logging` section:
+        > NOTE: This will be automatically formatted into code.
+      render: shell
+    validations:
+      required: true
+  - type: textarea
+    id: additional-info
+    attributes:
+      label: Additional info
+      description: Any additional information related to the issue (ex. browser console errors, software versions).
+    validations:
+      required: true

+ 0 - 166
.github/ISSUE_TEMPLATE/Bug_report.md

@@ -1,166 +0,0 @@
----
-name: 🐛 Bug report
-about: Help us improving by reporting a bug
-labels: bug, 0. Needs triage
----
-
-<!--
-Thanks for reporting issues back to Nextcloud!
-
-Note: This is the **issue tracker of Nextcloud**, please do NOT use this to get answers to your questions or get help for fixing your installation. This is a place to report bugs to developers, after your server has been debugged. You can find help debugging your system on our home user forums: https://help.nextcloud.com or, if you use Nextcloud in a large organization, ask our engineers on https://portal.nextcloud.com. See also  https://nextcloud.com/support for support options.
-
-Nextcloud is an open source project backed by Nextcloud GmbH. Most of our volunteers are home users and thus primarily care about issues that affect home users. Our paid engineers prioritize issues of our customers. If you are neither a home user nor a customer, consider paying somebody to fix your issue, do it yourself or become a customer.
-
-Guidelines for submitting issues:
-
-* Please search the existing issues first, it's likely that your issue was already reported or even fixed.
-    - Go to https://github.com/nextcloud and type any word in the top search/command bar. You probably see something like "We couldn’t find any repositories matching ..." then click "Issues" in the left navigation.
-    - You can also filter by appending e. g. "state:open" to the search string.
-    - More info on search syntax within github: https://help.github.com/articles/searching-issues
-    
-* This repository https://github.com/nextcloud/server/issues is *only* for issues within the Nextcloud Server code. This also includes the apps: files, encryption, external storage, sharing, deleted files, versions, LDAP, and WebDAV Auth
-  
-* SECURITY: Report any potential security bug to us via our HackerOne page (https://hackerone.com/nextcloud) following our security policy (https://nextcloud.com/security/) instead of filing an issue in our bug tracker.  
-
-* The issues in other components should be reported in their respective repositories: You will find them in our GitHub Organization (https://github.com/nextcloud/)
-  
-* You can also use the Issue Template app to prefill most of the required information: https://apps.nextcloud.com/apps/issuetemplate
--->
-
-<!--- Please keep this note for other contributors -->
-
-### How to use GitHub
-
-* Please use the 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to show that you are affected by the same issue.
-* Please don't comment if you have no relevant information to add. It's just extra noise for everyone subscribed to this issue.
-* Subscribe to receive notifications on status change and new comments. 
-
-
-### Steps to reproduce
-1.
-2.
-3.
-
-### Expected behaviour
-Tell us what should happen
-
-### Actual behaviour
-Tell us what happens instead
-
-### Server configuration
-
-**Operating system:**
-
-**Web server:**
-
-**Database:**
-
-**PHP version:**
-
-**Nextcloud version:** (see Nextcloud admin page)
-
-**Updated from an older Nextcloud/ownCloud or fresh install:**
-
-**Where did you install Nextcloud from:**
-
-**Signing status:**
-<details>
-<summary>Signing status</summary>
-
-```
-Login as admin user into your Nextcloud and access 
-http://example.com/index.php/settings/integrity/failed 
-paste the results here.
-```
-</details>
-
-**List of activated apps:**
-<details>
-<summary>App list</summary>
-
-```
-If you have access to your command line run e.g.:
-sudo -u www-data php occ app:list
-from within your Nextcloud installation folder
-```
-</details>
-
-**Nextcloud configuration:**
-<details>
-<summary>Config report</summary>
-
-```
-If you have access to your command line run e.g.:
-sudo -u www-data php occ config:list system
-from within your Nextcloud installation folder
-
-or 
-
-Insert your config.php content here. 
-Make sure to remove all sensitive content such as passwords. (e.g. database password, passwordsalt, secret, smtp password, …)
-```
-</details>
-
-**Are you using external storage, if yes which one:** local/smb/sftp/...
-
-**Are you using encryption:** yes/no
-
-**Are you using an external user-backend, if yes which one:** LDAP/ActiveDirectory/Webdav/...
-
-#### LDAP configuration (delete this part if not used)
-<details>
-<summary>LDAP config</summary>
-
-```
-With access to your command line run e.g.:
-sudo -u www-data php occ ldap:show-config
-from within your Nextcloud installation folder
-
-Without access to your command line download the data/owncloud.db to your local
-computer or access your SQL server remotely and run the select query:
-SELECT * FROM `oc_appconfig` WHERE `appid` = 'user_ldap';
-
-
-Eventually replace sensitive data as the name/IP-address of your LDAP server or groups.
-```
-</details>
-
-### Client configuration
-**Browser:**
-
-**Operating system:**
-
-### Logs
-
-<!--- Reports without logs might be closed as unqualified reports! -->
-
-#### Web server error log
-<details>
-<summary>Web server error log</summary>
-
-```
-Insert your webserver log here
-```
-</details>
-
-#### Nextcloud log (data/nextcloud.log)
-<details>
-<summary>Nextcloud log</summary>
-
-```
-Insert your Nextcloud log here
-```
-</details>
-
-#### Browser log
-<details>
-<summary>Browser log</summary>
-
-```
-Insert your browser log here, this could for example include:
-
-a) The javascript console log
-b) The network log
-c) ...
-```
-</details>