From ca3296b65aeb7a4eb84fdaccf01310ab7fd533d7 Mon Sep 17 00:00:00 2001 From: Bennett Blodinger Date: Thu, 2 Sep 2021 16:58:18 -0500 Subject: [PATCH 01/10] Update issue templates --- .github/ISSUE_TEMPLATE/Bug_report.md | 127 +++++++++++----------- .github/ISSUE_TEMPLATE/Feature_request.md | 49 +++++---- 2 files changed, 91 insertions(+), 85 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md index ae8ba15ed..2aef36e61 100644 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -1,62 +1,65 @@ ---- -name: Bug report -about: Create a report to help us improve - ---- - -#### Please confirm you have done the following before posting your bug report: - -- [ ] I have enabled debug mode -- [ ] I have read [checked the Common Issues page](https://snipe-it.readme.io/docs/common-issues) - -**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. - -**Server (please complete the following information):** - - Snipe-IT Version - - OS: [e.g. Ubuntu, CentOS] - - Web Server: [e.g. Apache, IIS] - - PHP Version - -**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] - -**Error Messages** -- WITH DEBUG TURNED ON, if you're getting an error in your browser, include that error -- If a stacktrace is provided in the error, include that too. -- Any errors that appear in your browser's error console. -- Confirm whether the error is reproducible on the demo: https://snipeitapp.com/demo. -- Include any additional information you can find in `storage/logs` and your webserver's logs. -- Include the output from `php -m` (this should display what modules you have enabled.) - -**Additional context** -- Is this a fresh install or an upgrade? -- What OS and web server you're running Snipe-IT on -- What method you used to install Snipe-IT (install.sh, manual installation, docker, etc) -- Include what you've done so far in the installation, and if you got any error messages along the way. -- Indicate whether or not you've manually edited any data directly in the database - -Add any other context about the problem here. - -Please do not post an issue without answering the related questions above. If you have opened a different issue and already answered these questions, answer them again, once for every ticket. It will be next to impossible for us to help you. +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +#### Please confirm you have done the following before posting your bug report: + +- [ ] I have enabled debug mode +- [ ] I have read [checked the Common Issues page](https://snipe-it.readme.io/docs/common-issues) + +**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. + +**Server (please complete the following information):** + - Snipe-IT Version + - OS: [e.g. Ubuntu, CentOS] + - Web Server: [e.g. Apache, IIS] + - PHP Version + +**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] + +**Error Messages** +- WITH DEBUG TURNED ON, if you're getting an error in your browser, include that error +- If a stacktrace is provided in the error, include that too. +- Any errors that appear in your browser's error console. +- Confirm whether the error is reproducible on the demo: https://snipeitapp.com/demo. +- Include any additional information you can find in `storage/logs` and your webserver's logs. +- Include the output from `php -m` (this should display what modules you have enabled.) + +**Additional context** +- Is this a fresh install or an upgrade? +- What OS and web server you're running Snipe-IT on +- What method you used to install Snipe-IT (install.sh, manual installation, docker, etc) +- Include what you've done so far in the installation, and if you got any error messages along the way. +- Indicate whether or not you've manually edited any data directly in the database + +Add any other context about the problem here. + +Please do not post an issue without answering the related questions above. If you have opened a different issue and already answered these questions, answer them again, once for every ticket. It will be next to impossible for us to help you. diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md index 66c3d199f..a61a8349f 100644 --- a/.github/ISSUE_TEMPLATE/Feature_request.md +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -1,23 +1,26 @@ ---- -name: Feature request -about: Suggest an idea for this project - ---- - -**Server (please complete the following information):** - - Snipe-IT Version - - OS: [e.g. Ubuntu, CentOS] - - Web Server: [e.g. Apache, IIS] - - PHP Version - -**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. +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Server (please complete the following information):** + - Snipe-IT Version + - OS: [e.g. Ubuntu, CentOS] + - Web Server: [e.g. Apache, IIS] + - PHP Version + +**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 37eac18c697867975132828dfdeed7e6f9d79985 Mon Sep 17 00:00:00 2001 From: Bennett Blodinger Date: Thu, 2 Sep 2021 17:27:27 -0500 Subject: [PATCH 02/10] Create bug_report.yml Using the (currently in beta) https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema --- .github/ISSUE_TEMPLATE/bug_report.yml | 120 ++++++++++++++++++++++++++ 1 file changed, 120 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..1094a4226 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,120 @@ +name: Bug Report +description: Create a report to help us improve +body: + - type: checkboxes + attributes: + label: Debug mode + description: Please confirm you have done the following before posting your bug report + options: + - label: I have enabled debug mode + required: true + - label: I have read [checked the Common Issues page](https://snipe-it.readme.io/docs/common-issues) + required: true + - type: textarea + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + attributes: + label: Reproduction steps + description: Steps to reproduce the behavior. + value: | + 1. + 2. + 3. + ... + validations: + required: true + - type: textarea + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true + - type: textarea + attributes: + label: Screenshots + description: 'If applicable, add screenshots to help explain your problem.' + - type: markdown + attributes: + value: Server + - type: input + attributes: + label: Snipe-IT Version + validations: + required: true + - type: input + attributes: + label: Operating System + description: 'e.g. Ubuntu, Windows' + validations: + required: true + - type: input + attributes: + label: Web Server + description: 'e.g. Apache, IIS' + validations: + required: true + - type: input + attributes: + label: PHP Version + validations: + required: true + - type: markdown + attributes: + value: Desktop + - type: input + attributes: + label: Operating System + description: 'e.g. Ubuntu, Windows' + - type: input + attributes: + label: Browser + description: 'e.g. Google Chrome, Safari' + - type: input + attributes: + label: Version + description: 'e.g. 93' + - type: markdown + attributes: + value: Mobile + - type: input + attributes: + label: Device + description: 'e.g. iPhone 6, Pixel 4a' + - type: input + attributes: + label: Operating System + description: 'e.g. iOS 8.1, Android 9' + - type: input + attributes: + label: Browser + description: 'e.g. Google Chrome, Safari' + - type: input + attributes: + label: Version + description: 'e.g. 93' + - type: textarea + attributes: + label: Error messages + description: WITH DEBUG TURNED ON, if you're getting an error in your browser, include that error | +If a stacktrace is provided in the error, include that too. | +Any errors that appear in your browser's error console. | +Confirm whether the error is reproducible on the demo: https://snipeitapp.com/demo. | +Include any additional information you can find in `storage/logs` and your webserver's logs. | +Include the output from `php -m` (this should display what modules you have enabled.) + render: shell + - type: textarea + attributes: + label: Additional context + description: Is this a fresh install or an upgrade? | +What OS and web server you're running Snipe-IT on | +What method you used to install Snipe-IT (install.sh, manual installation, docker, etc) | +Include what you've done so far in the installation, and if you got any error messages along the way. | +Indicate whether or not you've manually edited any data directly in the database | +Add any other context about the problem here. + - type: markdown + attributes: + value: Please do not post an issue without answering the related questions above. If you have opened a different issue and already answered these questions, answer them again, once for every ticket. It will be next to impossible for us to help you. From 4598fcf66630cf9ee4265238ba011a275626a7e4 Mon Sep 17 00:00:00 2001 From: Bennett Blodinger Date: Thu, 2 Sep 2021 17:27:46 -0500 Subject: [PATCH 03/10] Delete Bug_report.md --- .github/ISSUE_TEMPLATE/Bug_report.md | 65 ---------------------------- 1 file changed, 65 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/Bug_report.md diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md deleted file mode 100644 index 2aef36e61..000000000 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -#### Please confirm you have done the following before posting your bug report: - -- [ ] I have enabled debug mode -- [ ] I have read [checked the Common Issues page](https://snipe-it.readme.io/docs/common-issues) - -**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. - -**Server (please complete the following information):** - - Snipe-IT Version - - OS: [e.g. Ubuntu, CentOS] - - Web Server: [e.g. Apache, IIS] - - PHP Version - -**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] - -**Error Messages** -- WITH DEBUG TURNED ON, if you're getting an error in your browser, include that error -- If a stacktrace is provided in the error, include that too. -- Any errors that appear in your browser's error console. -- Confirm whether the error is reproducible on the demo: https://snipeitapp.com/demo. -- Include any additional information you can find in `storage/logs` and your webserver's logs. -- Include the output from `php -m` (this should display what modules you have enabled.) - -**Additional context** -- Is this a fresh install or an upgrade? -- What OS and web server you're running Snipe-IT on -- What method you used to install Snipe-IT (install.sh, manual installation, docker, etc) -- Include what you've done so far in the installation, and if you got any error messages along the way. -- Indicate whether or not you've manually edited any data directly in the database - -Add any other context about the problem here. - -Please do not post an issue without answering the related questions above. If you have opened a different issue and already answered these questions, answer them again, once for every ticket. It will be next to impossible for us to help you. From a8a6950b7e4f1ac669b42a290cc0e2b4350420cb Mon Sep 17 00:00:00 2001 From: Bennett Blodinger Date: Thu, 2 Sep 2021 17:28:01 -0500 Subject: [PATCH 04/10] Delete Feature_request.md --- .github/ISSUE_TEMPLATE/Feature_request.md | 26 ----------------------- 1 file changed, 26 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/Feature_request.md diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md deleted file mode 100644 index a61a8349f..000000000 --- a/.github/ISSUE_TEMPLATE/Feature_request.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -**Server (please complete the following information):** - - Snipe-IT Version - - OS: [e.g. Ubuntu, CentOS] - - Web Server: [e.g. Apache, IIS] - - PHP Version - -**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 a1674f8d58f844f3747e3bbdfd40f24bf6f2f9ec Mon Sep 17 00:00:00 2001 From: Bennett Blodinger Date: Thu, 2 Sep 2021 17:29:36 -0500 Subject: [PATCH 05/10] Create config.yml --- .github/ISSUE_TEMPLATE/config.yml | 1 + 1 file changed, 1 insertion(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..3ba13e0ce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false From 43b7c844b0ee601f7ac71ac8cf79e3cdf4311184 Mon Sep 17 00:00:00 2001 From: Bennett Blodinger Date: Thu, 2 Sep 2021 17:32:31 -0500 Subject: [PATCH 06/10] multiline --- .github/ISSUE_TEMPLATE/bug_report.yml | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 1094a4226..1c609a942 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -99,22 +99,24 @@ body: - type: textarea attributes: label: Error messages - description: WITH DEBUG TURNED ON, if you're getting an error in your browser, include that error | -If a stacktrace is provided in the error, include that too. | -Any errors that appear in your browser's error console. | -Confirm whether the error is reproducible on the demo: https://snipeitapp.com/demo. | -Include any additional information you can find in `storage/logs` and your webserver's logs. | -Include the output from `php -m` (this should display what modules you have enabled.) + description: | + WITH DEBUG TURNED ON, if you're getting an error in your browser, include that error + If a stacktrace is provided in the error, include that too. + Any errors that appear in your browser's error console. + Confirm whether the error is reproducible on the demo: https://snipeitapp.com/demo. + Include any additional information you can find in `storage/logs` and your webserver's logs. + Include the output from `php -m` (this should display what modules you have enabled.) render: shell - type: textarea attributes: label: Additional context - description: Is this a fresh install or an upgrade? | -What OS and web server you're running Snipe-IT on | -What method you used to install Snipe-IT (install.sh, manual installation, docker, etc) | -Include what you've done so far in the installation, and if you got any error messages along the way. | -Indicate whether or not you've manually edited any data directly in the database | -Add any other context about the problem here. + description: | + Is this a fresh install or an upgrade? + What OS and web server you're running Snipe-IT on + What method you used to install Snipe-IT (install.sh, manual installation, docker, etc) + Include what you've done so far in the installation, and if you got any error messages along the way. + Indicate whether or not you've manually edited any data directly in the database + Add any other context about the problem here. - type: markdown attributes: value: Please do not post an issue without answering the related questions above. If you have opened a different issue and already answered these questions, answer them again, once for every ticket. It will be next to impossible for us to help you. From 51a359496acded9107c5ce02ac265d84ae787df4 Mon Sep 17 00:00:00 2001 From: Bennett Blodinger Date: Thu, 2 Sep 2021 17:37:47 -0500 Subject: [PATCH 07/10] unique IDs --- .github/ISSUE_TEMPLATE/bug_report.yml | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 1c609a942..65a5c0c36 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -25,7 +25,7 @@ body: 2. 3. ... - validations: + validations: required: true - type: textarea attributes: @@ -46,6 +46,7 @@ body: validations: required: true - type: input + id: server_operatingSystem attributes: label: Operating System description: 'e.g. Ubuntu, Windows' @@ -66,14 +67,17 @@ body: attributes: value: Desktop - type: input + id: desktop_operatingSystem attributes: label: Operating System description: 'e.g. Ubuntu, Windows' - type: input + id: desktop_browser attributes: label: Browser description: 'e.g. Google Chrome, Safari' - type: input + id: desktop_version attributes: label: Version description: 'e.g. 93' @@ -85,14 +89,17 @@ body: label: Device description: 'e.g. iPhone 6, Pixel 4a' - type: input + id: device_operatingSystem attributes: label: Operating System description: 'e.g. iOS 8.1, Android 9' - type: input + id: device_browser attributes: label: Browser description: 'e.g. Google Chrome, Safari' - type: input + id: device_version attributes: label: Version description: 'e.g. 93' @@ -106,7 +113,7 @@ body: Confirm whether the error is reproducible on the demo: https://snipeitapp.com/demo. Include any additional information you can find in `storage/logs` and your webserver's logs. Include the output from `php -m` (this should display what modules you have enabled.) - render: shell + render: shell - type: textarea attributes: label: Additional context From 391d4f839a147644b37a9014c94586c7da5dc90a Mon Sep 17 00:00:00 2001 From: Bennett Blodinger Date: Thu, 2 Sep 2021 17:43:24 -0500 Subject: [PATCH 08/10] formatting --- .github/ISSUE_TEMPLATE/bug_report.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 65a5c0c36..5cc00c2a3 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -39,7 +39,7 @@ body: description: 'If applicable, add screenshots to help explain your problem.' - type: markdown attributes: - value: Server + value: "### Server" - type: input attributes: label: Snipe-IT Version @@ -65,7 +65,7 @@ body: required: true - type: markdown attributes: - value: Desktop + value: "### Desktop" - type: input id: desktop_operatingSystem attributes: @@ -83,23 +83,23 @@ body: description: 'e.g. 93' - type: markdown attributes: - value: Mobile + value: "### Mobile" - type: input attributes: label: Device description: 'e.g. iPhone 6, Pixel 4a' - type: input - id: device_operatingSystem + id: mobile_operatingSystem attributes: label: Operating System description: 'e.g. iOS 8.1, Android 9' - type: input - id: device_browser + id: mobile_browser attributes: label: Browser description: 'e.g. Google Chrome, Safari' - type: input - id: device_version + id: mobile_version attributes: label: Version description: 'e.g. 93' From 563edddfc5b7ed7838b721752d3dde51e726fca8 Mon Sep 17 00:00:00 2001 From: Bennett Blodinger Date: Thu, 2 Sep 2021 17:47:32 -0500 Subject: [PATCH 09/10] add a feature request --- .github/ISSUE_TEMPLATE/feature_request.yml | 45 ++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..3072576d6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,45 @@ +name: Feature Request +description: Suggest an idea for this project +body: + - type: markdown + attributes: + value: "### Server" + - type: input + attributes: + label: Snipe-IT Version + validations: + required: true + - type: input + id: server_operatingSystem + attributes: + label: Operating System + description: 'e.g. Ubuntu, Windows' + validations: + required: true + - type: input + attributes: + label: Web Server + description: 'e.g. Apache, IIS' + validations: + required: true + - type: input + attributes: + label: PHP Version + validations: + required: true + - type: textarea + attributes: + label: 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 [...] + validations: + required: true + - type: textarea + attributes: + label: Describe the solution you'd like A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + attributes: + label: Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered. + - type: textarea + attributes: + label: Additional context Add any other context or screenshots about the feature request here. From 034eb5fb07f5a9a77bb29274de521ba6a50b9720 Mon Sep 17 00:00:00 2001 From: Bennett Blodinger Date: Thu, 2 Sep 2021 17:48:38 -0500 Subject: [PATCH 10/10] no markdown? --- .github/ISSUE_TEMPLATE/feature_request.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 3072576d6..3c21c8a47 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,9 +1,6 @@ name: Feature Request description: Suggest an idea for this project body: - - type: markdown - attributes: - value: "### Server" - type: input attributes: label: Snipe-IT Version