From dc5f4245201670bedf47440a1d6e337ccc5d7c9f Mon Sep 17 00:00:00 2001 From: Stavros Kois <47820033+stavros-k@users.noreply.github.com> Date: Sun, 20 Feb 2022 10:56:46 +0200 Subject: [PATCH] feat(project): Migrate to Issue Forms (#1910) * Add initial app_request form * format * textarea * Add feature_request * init bug repot * format * placerholder * format * format * remove md bugreport * Add icons to pull request * More icons --- .github/ISSUE_TEMPLATE/app_request.md | 10 -- .github/ISSUE_TEMPLATE/app_request.yaml | 27 +++++ .github/ISSUE_TEMPLATE/bug_report.md | 80 ------------- .github/ISSUE_TEMPLATE/bug_report.yaml | 122 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ---- .github/ISSUE_TEMPLATE/feature_request.yaml | 35 ++++++ .github/PULL_REQUEST_TEMPLATE.md | 32 ++--- 7 files changed, 200 insertions(+), 126 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/app_request.md create mode 100644 .github/ISSUE_TEMPLATE/app_request.yaml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml diff --git a/.github/ISSUE_TEMPLATE/app_request.md b/.github/ISSUE_TEMPLATE/app_request.md deleted file mode 100644 index 531dc7a7186..00000000000 --- a/.github/ISSUE_TEMPLATE/app_request.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: App Request -about: Request new apps to add to TrueCharts -title: 'Add APPNAME' -labels: ['New App Request', 'backlog'] -assignees: '' - ---- - -**Describe the app you request to be added** diff --git a/.github/ISSUE_TEMPLATE/app_request.yaml b/.github/ISSUE_TEMPLATE/app_request.yaml new file mode 100644 index 00000000000..ccea21acf8f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/app_request.yaml @@ -0,0 +1,27 @@ +name: ๐Ÿ“ƒ App Request ๐Ÿ™ +description: Request new apps to be added to TrueCharts Catalog +title: "[Add]: " +labels: ["New App Request", "backlog"] +body: + - type: markdown + attributes: + value: | + Thanks for making this request. + Keep in mind that this request is not a guarantee that the app will be added. + + --- + - type: textarea + attributes: + label: Short description of the app + description: Describe what the app does in a few words + placeholder: Ex. An online platform to share your code. + validations: + required: true + - type: textarea + attributes: + label: Sources + description: | + Provide source links for the app. + Like documentation, github repo, container image, etc + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 998ac672230..00000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve TrueCharts -title: '[APPNAME] bugdescription' -labels: bug -assignees: '' - ---- - - - - - -***SCALE version*** - - -***App Version*** - - -***Application Events*** - - -***Application Logs*** - - -***Application Configuration*** - - - -**Describe the bug** - - -**To Reproduce** - - -**Expected behavior** - - -**Screenshots** - - -**Additional context** - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 00000000000..6dd78b74e17 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,122 @@ +name: โš™๏ธ Bug Report ๐Ÿช› +description: Request new apps to be added to TrueCharts Catalog +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for making this bug report. + + โš ๏ธ Mind your title. โš ๏ธ + + - "App stuck in deploying state" - Is not the title/description of your actual bug. + - "Appname not working" - Is not the title/description of your actual bug. + - Don't refer version in title. + + --- + + - type: input + id: app-name + attributes: + label: App Name + description: | + The name of the app having the issue. + validations: + required: true + - type: dropdown + id: os-version + attributes: + label: SCALE Version + description: | + The version of truenas scale you are currently running. + FOUND IN: System Settings > General > OS Version + multiple: false + options: + - "22.02.0" + - "22.02-RC2" + validations: + required: true + - type: input + id: app-version + attributes: + label: App Version + description: | + The version of the app having the issue and versions of any apps being used in conjunction. + FOUND IN: Apps > Installed Applications + validations: + required: true + - type: textarea + id: app-events + attributes: + label: Application Events + description: | + Debug information from the app(s) specifically + FOUND IN: Apps > Installed Applications > (Click on the app name) > Click the caret next to application events and include a screenshot here. + render: Shell + validations: + required: true + - type: textarea + id: app-logs + attributes: + label: Application Logs + description: | + Log output from the containers involved in the app + FOUND IN: Apps > Installed Applications > (Click the 3 dots on the top right of the app box) > Logs + Open the logs for each pod used for the app and copy/paste here. + + Note: It can take a moment for the logs to show on the logs screen. + render: Shell + validations: + required: true + - type: textarea + id: app-config + attributes: + label: Application Configuration + description: | + The configuration settings for the app (Make sure to include what you have changed AND what you didn't change). + If possible use the edit features in your screenshot tool to highlight the portions you changed intentionally. + FOUND IN: Apps > Installed Applications > (Click the 3 dots on the top right of the app box) > Edit + validations: + required: true + - type: textarea + id: bug-report + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + id: repro-steps + attributes: + label: To Reproduce + description: | + Make sure that if you follow these steps again yourself the bug happens again. If it doesn't it's Probably a configuration error and should be handled with a support ticket on the discord. + Steps to reproduce the behavior: + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error. + validations: + required: true + - type: textarea + id: exp-behaviour + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: If applicable, add screenshots to help explain your problem. + validations: + required: true + - type: textarea + id: add-contaxt + attributes: + label: Additional Context + description: Add any other context about the problem here. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index c95a0b8f1d6..00000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature or Enhancement request -about: Suggest an idea for this project -title: '' -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 [...] - -**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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 00000000000..5125ac3e3c5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,35 @@ +name: โš™๏ธ Feature or Enhancement Request ๐Ÿ™ +description: Suggest an idea for TrueCharts +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Thanks for making this suggestion. + + --- + - type: textarea + attributes: + label: Is your feature request related to a problem? + description: A clear and concise description of what the problem is. + placeholder: Ex. I'm always frustrated when [...] + validations: + required: true + - type: textarea + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: true + - type: textarea + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here. + validations: + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 727146ac3a0..9d24beea1a0 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,29 +2,29 @@ -Fixes # +โš’๏ธ Fixes # -**Type of change** +**โš™๏ธ Type of change** -- [ ] Feature/App addition -- [ ] Bugfix -- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) -- [ ] Refactor of current code +- [ ] โš™๏ธ Feature/App addition +- [ ] ๐Ÿช› Bugfix +- [ ] โš ๏ธ Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] ๐Ÿ”ƒ Refactor of current code -**How Has This Been Tested?** +**๐Ÿงช How Has This Been Tested?** -**Notes:** +**๐Ÿ“ƒ Notes:** -**Checklist:** +**โœ”๏ธ Checklist:** -- [ ] My code follows the style guidelines of this project -- [ ] I have performed a self-review of my own code -- [ ] I have commented my code, particularly in hard-to-understand areas -- [ ] I have made corresponding changes to the documentation -- [ ] My changes generate no new warnings -- [ ] I have added tests to this description that prove my fix is effective or that my feature works -- [ ] I increased versions for any altered app according to semantic versioning +- [ ] โš–๏ธ My code follows the style guidelines of this project +- [ ] ๐Ÿ‘€ I have performed a self-review of my own code +- [ ] #๏ธโƒฃ I have commented my code, particularly in hard-to-understand areas +- [ ] ๐Ÿ“„ I have made corresponding changes to the documentation +- [ ] โš ๏ธ My changes generate no new warnings +- [ ] ๐Ÿงช I have added tests to this description that prove my fix is effective or that my feature works +- [ ] โฌ†๏ธ I increased versions for any altered app according to semantic versioning