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
This commit is contained in:
Stavros Kois
2022-02-20 10:56:46 +02:00
committed by GitHub
parent 77c7428098
commit dc5f424520
7 changed files with 200 additions and 126 deletions
-10
View File
@@ -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**
+27
View File
@@ -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
-80
View File
@@ -1,80 +0,0 @@
---
name: Bug report
about: Create a report to help us improve TrueCharts
title: '[APPNAME] bugdescription'
labels: bug
assignees: ''
---
<!--
MIND YOUR TITLE:
- "App in a 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 to a version, bugs are always for latest version
-->
***SCALE version***
<!--
- the version of truenas scale you are currently running.
- FOUND IN: System settings > general > os version
-->
***App Version***
<!--
- the version of the app having the issue and versions of any apps being used in conjunction
- FOUND IN: apps > installed applications
-->
***Application Events***
<!--
- debug information from the app(s) specifically
- FOUND IN: apps > installed applications > (click on the app name) > click the carrot next to application events and include a screenshot here
-->
***Application Logs***
<!--
- 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 take a screenshot
- it can take a moment for the logs to show on the logs screen
-->
***Application Configuration***
<!--
- the configuration settings for the app (make sure to include what you have changed and what you didnt change
- if possible use the edit features in your screenshot tool to highlight the portions you cnaged intentionally
- FOUND IN: apps > installed applications > (click the 3 dots on the top right of the app box) edit
-->
**Describe the bug**
<!--
A clear and concise description of what the bug is.
-->
**To Reproduce**
<!--
- make sure that if you follow these steps again yourself the bug happens again. if it doesnt its probbly a configuration error and should be handled with a support thread on the discord
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.
-->
**Additional context**
<!--
Add any other context about the problem here.
-->
+122
View File
@@ -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
-20
View File
@@ -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.
@@ -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
+16 -16
View File
@@ -2,29 +2,29 @@
<!--
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
-->
Fixes # <!--(issue)-->
⚒️ Fixes # <!--(issue)-->
**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?**
<!--
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
-->
**Notes:**
**📃 Notes:**
<!-- Please enter any other relevant information here -->
**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