Akatsuki-Misaki/ArchiSteamFarm
1
0
Fork 0
mirror of https://github.com/JustArchiNET/ArchiSteamFarm.git synced 2026-01-01 06:00:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Further update issue templates

Browse Source
This commit is contained in:
Archi
2021-12-16 00:34:06 +01:00
parent 55745c8093
commit eb8946e480
3 changed files with 65 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
.github/ISSUE_TEMPLATE/Bug-report.yml vendored
View File

@@ -102,7 +102,9 @@ body:
id: help
attributes:
label: Can you help us with this bug report?
description: ASF is offered for free and our resources are limited. Helping us increases the chance of fixing the problem.
description: |
ASF is offered for free and our resources are limited.
Helping us increases the chance of fixing the problem.
options:
- Yes, I can code the solution myself and send a pull request
- Somehow, I can test and offer feedback, but can't code
@@ -113,9 +115,24 @@ body:
id: asf-log
attributes:
label: Full log.txt recorded during reproducing the problem
description: You can find `log.txt` file directly in ASF directory. If the bug report doesn't come from the last run of the program, you can find logs from previous runs of the program in the `logs` directory instead.
description: |
You can find `log.txt` file directly in ASF directory.
If the bug report doesn't come from the last run of the program, you can find logs from previous runs of the program in the `logs` directory instead.
If no `log.txt` was recorded due to crash at the very early stage, console output should be pasted instead.
placeholder: |
If no log.txt was recorded due to crash at the very early stage, console output should be pasted instead.
2021-12-16 00:20:43|dotnet-282887|INFO|ASF|InitCore() ArchiSteamFarm V5.2.1.2 (generic/6b492ffa-9927-431d-bae7-7360ab9968a9 | .NET 6.0.0-rtm.21522.10; debian-arm64; Linux 5.15.0-1-arm64 #1 SMP Debian 5.15.3-1 (2021-11-18))
2021-12-16 00:20:43|dotnet-282887|INFO|ASF|InitCore() Copyright © 2015-2021 JustArchiNET
2021-12-16 00:20:47|dotnet-282887|INFO|ASF|InitPlugins() Initializing Plugins...
2021-12-16 00:20:47|dotnet-282887|INFO|ASF|InitPlugins() Loading SteamTokenDumperPlugin V5.2.1.2...
2021-12-16 00:20:47|dotnet-282887|INFO|ASF|InitPlugins() SteamTokenDumperPlugin has been loaded successfully!
2021-12-16 00:20:47|dotnet-282887|INFO|ASF|UpdateAndRestart() ASF will automatically check for new versions every 1 day.
2021-12-16 00:20:52|dotnet-282887|INFO|ASF|Update() Checking for new version...
2021-12-16 00:20:54|dotnet-282887|INFO|ASF|Update() Local version: 5.2.1.2 | Remote version: 5.2.1.2
2021-12-16 00:20:54|dotnet-282887|INFO|ASF|Load() Loading STD global cache...
2021-12-16 00:20:56|dotnet-282887|INFO|ASF|Load() Validating STD global cache integrity...
2021-12-16 00:20:56|dotnet-282887|INFO|ASF|OnASFInit() SteamTokenDumperPlugin has been initialized successfully, thank you in advance for your help. The first submission will happen in approximately 47 minutes from now.
2021-12-16 00:20:57|dotnet-282887|INFO|ASF|Start() Starting IPC server...
2021-12-16 00:20:59|dotnet-282887|INFO|ASF|Start() IPC server ready!
render: text
validations:
required: true
@@ -123,9 +140,9 @@ body:
id: global-config
attributes:
label: Global ASF.json config file
description: The config can be found in `config` directory under `ASF.json` name. You can leave this field empty if not using one.
placeholder: |
Paste the file content here, no need for triple backtick tags
description: |
The config can be found in `config` directory under `ASF.json` name.
You can leave this field empty if not using one.
Ensure that your config has redacted (but NOT removed) potentially-sensitive properties, such as:
- IPCPassword (recommended)
@@ -135,14 +152,21 @@ body:
- WebProxyUsername (optionally, if exposing private details)
Redacting involves replacing sensitive details, for example with stars (***). You should refrain from removing config lines entirely, as their pure existence may be relevant and should be preserved.
placeholder: |
{
"AutoRestart": false,
"Headless": true,
"UpdateChannel": 2,
"SteamTokenDumperPluginEnabled": true
}
render: json
- type: textarea
id: bot-config
attributes:
label: BotName.json config of all affected bot instances
description: Bot config files can be found in `config` directory, ending with `json` extension. You can leave this field empty if you don't have any defined.
placeholder: |
Paste the file content here, no need for triple backtick tags
description: |
Bot config files can be found in `config` directory, ending with `json` extension.
You can leave this field empty if you don't have any defined.
Ensure that your config has redacted (but NOT removed) potentially-sensitive properties, such as:
- SteamLogin (mandatory)
@@ -153,6 +177,10 @@ body:
- SteamUserPermissions (optionally, only SteamIDs)
Redacting involves replacing sensitive details, for example with stars (***). You should refrain from removing config lines entirely, as their pure existence may be relevant and should be preserved.
placeholder: |
{
"Enabled": true
}
render: json
- type: textarea
id: additional-info

20
.github/ISSUE_TEMPLATE/Enhancement-idea.yml vendored
View File

@@ -26,8 +26,10 @@ body:
id: enhancement-purpose
attributes:
label: Enhancement purpose
description: Purpose of the enhancement - if it solves some problem, precise in particular which. If it benefits the program in some other way, precise in particular why.
placeholder: Present the underlying reason why this enhancement makes sense, and what is the context of it.
description: |
Purpose of the enhancement - if it solves some problem, precise in particular which. If it benefits the program in some other way, precise in particular why.
Present the underlying reason why this enhancement makes sense, and what is the context of it.
placeholder: As of today ASF offers variety of beverages, such as latte macchiato or cappuccino. I'd appreciate if ASF offered some no-milk options as well, for example espresso or ristretto. I believe it'd further improve the program offering the users wider selection, which is very convenient.
validations:
required: true
- type: textarea
@@ -35,25 +37,29 @@ body:
attributes:
label: Solution
description: What would you like to see as a solution to the purpose specified by you above?
placeholder: What would work for you?
placeholder: |
Simply add an option to brew some no-milk types of coffee. The existing logic is fine, we just need wider choice!
validations:
required: true
- type: textarea
id: why-existing-not-sufficient
attributes:
label: Why currently available solutions are not sufficient?
description: Evaluate the existing solutions in regards to your requirements.
placeholder: |
description: |
Evaluate the existing solutions in regards to your requirements.
If something you're suggesting is already possible, then explain to us why the currently available solutions are not sufficient.
If it's not possible yet, then explain to us why it should be.
placeholder: |
I'm allergic to milk, there is currently no option to pick a beverage that doesn't include it. Temporarily I'm switching cup mid-brewing as a workaround, but that is suboptimal considering the milk wasted.
validations:
required: true
- type: dropdown
id: help
attributes:
label: Can you help us with this enhancement idea?
description: ASF is offered for free and our resources are limited. Helping us increases the chance of making it happen.
description: |
ASF is offered for free and our resources are limited.
Helping us increases the chance of making it happen.
options:
- Yes, I can code the solution myself and send a pull request
- Somehow, I can test and offer feedback, but can't code

22
.github/ISSUE_TEMPLATE/Wiki-suggestion.yml vendored
View File

@@ -20,7 +20,9 @@ body:
id: wiki-page
attributes:
label: Wiki page
description: If this is a suggestion regarding an existing wiki page, please link it for reference. If the wiki page doesn't exist, suggest its title.
description: |
If this is a suggestion regarding an existing wiki page, please link it for reference.
If the wiki page doesn't exist, suggest its title.
placeholder: https://github.com/JustArchiNET/ArchiSteamFarm/wiki/???
validations:
required: true
@@ -28,26 +30,32 @@ body:
id: issue
attributes:
label: The issue
description: Please specify your issue in regards to our wiki documentation.
placeholder: |
description: |
Please specify your issue in regards to our wiki documentation.
If you're reporting a mistake/correction, state what is wrong.
If you're suggesting an idea, explain the details.
placeholder: |
As of today the wiki doesn't explain how to sign famous song composed by Rick Astlet - Never Gonna Give You Up.
I'm sick of googling the lyrics every time I'm opening a complaint on your GitHub, so please consider just adding it along the other stuff.
validations:
required: true
- type: textarea
id: wrong-text
attributes:
label: Wrong text
description: The existing text on the wiki which you classify as wrong.
placeholder: |
description: |
The existing text on the wiki which you classify as wrong.
If you're suggesting a new page, paragraph or other addition to the wiki, then this section is not mandatory.
placeholder: |
Lack of song lyrics is what's wrong!
render: markdown
- type: textarea
id: suggested-improvement
attributes:
label: Suggested improvement
description: The new or corrected text that would satisfy your issue stated above. You may use **[markdown](https://guides.github.com/features/mastering-markdown)** for formatting.
description: |
The new or corrected text that would satisfy your issue stated above.
You may use **[markdown](https://guides.github.com/features/mastering-markdown)** for formatting.
placeholder: |
# Never Gonna Give You Up by Rick Astley