update bug / feature report templates to use comments

This commit is contained in:
Send_Nukez 2021-11-27 10:00:31 +01:00
parent 8e702a49e1
commit 2e1b7a05b5
3 changed files with 64 additions and 50 deletions

View file

@ -8,28 +8,32 @@ assignees: ""
---
**Describe the bug**
A clear and concise description of what the bug is.
<!-- A clear and concise description of what the bug is. -->
**To Reproduce**
Steps to reproduce the behavior:
1.
**Screenshots**
If applicable, add screenshots to help explain your problem.
<!-- If applicable, add screenshots to help explain your problem. -->
**Desktop Setup**
- Operating System: [e.g. Windows 10, MacOS 10.14]
- Spotify version [e.g. 1.1.71.560] from `Menu (Three dots top left) > Help > About`
- Spicetify version [e.g. 2.4.1] run `spicetify -v`
- Dribbblish version [e.g. 3.0.1] from `Dribblish Settings > About`
- Operating System: <!-- [e.g. Windows 10, MacOS 10.14] -->
- Spotify: <!-- [e.g. 1.1.71.560] from `Menu (Three dots top left) > Help > About` -->
- Spicetify: <!-- [e.g. 2.4.1] run `spicetify -v` -->
- Dribbblish: <!-- [e.g. 3.0.1] from `Dribblish Settings > About` -->
**Logs**
Add logs from console. To do that
1. Run `spicetify enable-devtool` in terminal
2. Spotify will be restarted
3. Hit <kbd>Ctrl + Shift + I</kbd> to open DevTools window
4. Navigate to tab Console
5. Copy console window content.
<!--
Add logs from console. To do that
1. Run `spicetify enable-devtool` in terminal
2. Spotify will be restarted
3. Hit <kbd>Ctrl + Shift + I</kbd> to open DevTools window
4. Navigate to tab Console
5. Copy console window content.
-->
<!-- Paste logs below or attach a screenshot -->
```console
(Please paste here console logs or attach a screenshot)
```

View file

@ -8,13 +8,13 @@ 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 [...]
<!-- 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.
<!-- 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.
<!-- 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.
<!-- Add any other context or screenshots about the feature request here. -->

View file

@ -357,45 +357,55 @@ Dribbblish.on("ready", () => {
data: "Create Report",
onChange: () => {
const reportBody = `
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Logs**
**Describe the bug**
<!-- A clear and concise description of what the bug is. -->
**To Reproduce**
Steps to reproduce the behavior:
1.
**Screenshots**
<!-- If applicable, add screenshots to help explain your problem. -->
**Desktop Setup**
- Operating System: <!-- [e.g. Windows 10, MacOS 10.14] -->
- Spotify: <!-- [e.g. 1.1.71.560] from \`Menu (Three dots top left) > Help > About\` -->
- Spicetify: <!-- [e.g. 2.4.1] run \`spicetify -v\` -->
- Dribbblish: <!-- [e.g. 3.0.1] from \`Dribblish Settings > About\` -->
**Logs**
<!--
Add logs from console. To do that
1. Run \`spicetify enable-devtool\` in terminal
2. Spotify will be restarted
3. Hit <kbd>Ctrl + Shift + I</kbd> to open DevTools window
4. Navigate to tab Console
5. Copy console window content.
\`\`\`console
(Please paste here console logs or attach a screenshot)
\`\`\`
---
### Info for Contributors:
**Versions**
${Dribbblish.config.getOptions("aboutDribbblishInfo").description}
**Extensions**
${$(`script[src^="extensions/"]`)
.toArray()
.map((e) => `- ${e.src.split("/").slice(-1)[0]}`)
.join("\n")}
**Settings**
\`\`\`json
${JSON.stringify(Dribbblish.config.export(), null, 4)}
\`\`\`
`
-->
<!-- Paste logs below or attach a screenshot -->
\`\`\`console
\`\`\`
---
### Info for Contributors:
**Versions**
${Dribbblish.config.getOptions("aboutDribbblishInfo").description}
**Extensions**
${$(`script[src^="extensions/"]`)
.toArray()
.map((e) => `- ${e.src.split("/").slice(-1)[0]}`)
.join("\n")}
**Settings**
\`\`\`json
${JSON.stringify(Dribbblish.config.export(), null, 4)}
\`\`\`
`
.split("\n")
.map((line) => line.replace(/^ {16}/, ""))
.join("\n");