From 00a24106319ede2d9244b495c880be834817afa4 Mon Sep 17 00:00:00 2001 From: acsfer Date: Thu, 20 Jan 2022 19:19:40 +0100 Subject: [PATCH] Supercharge bug reports template More easy to fill, more accurate bug reports. :) --- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 212 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/Bug_report.md | 166 -------------------- 2 files changed, 212 insertions(+), 166 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/BUG_REPORT.yml delete mode 100644 .github/ISSUE_TEMPLATE/Bug_report.md diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml new file mode 100644 index 00000000000..a0742cd76ab --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -0,0 +1,212 @@ +name: "Bug report: Nextcloud Server" +description: "Submit a report and help us improve Nextcloud Server" +title: "[Bug]: " +labels: ["bug", "needs triage"] +body: + - type: markdown + attributes: + value: "### Thank you for contributing to our project!" + - type: markdown + attributes: + value: | + Before submitting, we'd appreciate it if you: + - Verify that your issue is not already reported. Search for it on Github. + - Check if your Nextcloud Server is up to date. If not, we recommend that you update it first. + - 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: expected-behavior + attributes: + label: Expected behavior + description: Describe what you expected to happen. + 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: 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" + - "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: PHP engine version + 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" + - "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: + - "Enabled" + - "Disabled" + validations: + required: true + - type: dropdown + id: users + attributes: + label: Are you using an external user-backend? + description: | + Select if an external user-backend is Enabled on your Nextcloud Server. + Describe in the "Additional info" section if you chose "Other". + options: + - "LDAP/ Active Directory" + - "SSO - SAML" + - "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: false + - 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: false + - 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: false + - 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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md deleted file mode 100644 index 7db40cf0066..00000000000 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -name: 🐛 Bug report -about: Help us improving by reporting a bug -labels: bug, 0. Needs triage ---- - - - - - -### 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:** -
-Signing status - -``` -Login as admin user into your Nextcloud and access -http://example.com/index.php/settings/integrity/failed -paste the results here. -``` -
- -**List of activated apps:** -
-App list - -``` -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 -``` -
- -**Nextcloud configuration:** -
-Config report - -``` -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, …) -``` -
- -**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) -
-LDAP config - -``` -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. -``` -
- -### Client configuration -**Browser:** - -**Operating system:** - -### Logs - - - -#### Web server error log -
-Web server error log - -``` -Insert your webserver log here -``` -
- -#### Nextcloud log (data/nextcloud.log) -
-Nextcloud log - -``` -Insert your Nextcloud log here -``` -
- -#### Browser log -
-Browser log - -``` -Insert your browser log here, this could for example include: - -a) The javascript console log -b) The network log -c) ... -``` -