mirror of
https://github.com/JustArchiNET/ArchiSteamFarm
synced 2024-11-10 15:14:41 +00:00
Update issue templates
This commit is contained in:
Łukasz Domeradzki
GitHub
parent
7a984b6f10
commit
a4bfc9700f
2 changed files with 124 additions and 120 deletions
162
.github/ISSUE_TEMPLATE/Bug_report.md
vendored
162
.github/ISSUE_TEMPLATE/Bug_report.md
vendored
|
|
@ -1,80 +1,82 @@
|
|||
---
|
||||
|
||||
name: Bug report
|
||||
about: Unexpected program behaviour that needs code correction
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
I fully read and understood contributing guidelines of ASF available under https://github.com/JustArchiNET/ArchiSteamFarm/blob/master/.github/CONTRIBUTING.md and I believe that my issue is valid - it requires a response from ASF development team, and not ASF support.
|
||||
|
||||
I understand that if my issue is not meeting contributing guidelines specified above, especially if it's a question or technical issue that is not related to ASF development in any way, then it will be closed and left unanswered.
|
||||
|
||||
Feel free to remove our notice and fill the template below with your details.
|
||||
-->
|
||||
|
||||
## Bug report
|
||||
|
||||
### Description
|
||||
|
||||
<!-- Short explanation of what you were going to do, what did you want to accomplish? -->
|
||||
|
||||
### Expected behavior
|
||||
|
||||
<!-- What did you expect to happen? -->
|
||||
|
||||
### Current behavior
|
||||
|
||||
<!-- What happened instead? -->
|
||||
|
||||
### Possible solution
|
||||
|
||||
<!-- Not mandatory, but you can suggest a fix/reason for the bug, if known to you. -->
|
||||
|
||||
### Steps to reproduce
|
||||
|
||||
<!-- Every command or action that happened after launching ASF, which leads to the bug. -->
|
||||
<!-- If launching ASF with provided configs (below) is everything that is needed, then this section is not mandatory. -->
|
||||
|
||||
### Full log.txt recorded during reproducing the problem
|
||||
|
||||
```
|
||||
Paste here, in-between triple backtick tags
|
||||
|
||||
Ensure that your log is complete and was NOT recorded in Debug mode, as debug log may contain sensitive information that should not be shared publicly, as per our the wiki. Standard ASF log does not include sensitive information.
|
||||
```
|
||||
|
||||
### Global ASF.json config (if using one)
|
||||
|
||||
```json
|
||||
Paste here, in-between triple backtick tags
|
||||
|
||||
Ensure that your config has redacted (but NOT removed) potentially-sensitive properties, such as:
|
||||
- IPCPassword (recommended)
|
||||
- SteamOwnerID (optionally)
|
||||
- WebProxy (optionally, if exposing private details)
|
||||
- WebProxyPassword (optionally, if exposing private details)
|
||||
- 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.
|
||||
```
|
||||
|
||||
### BotName.json config of all affected bot instances (if more than one)
|
||||
|
||||
```json
|
||||
Paste here, in-between triple backtick tags
|
||||
|
||||
Ensure that your config has redacted (but NOT removed) potentially-sensitive properties, such as:
|
||||
- SteamLogin (mandatory)
|
||||
- SteamPassword (mandatory)
|
||||
- SteamMasterClanID (optionally)
|
||||
- SteamParentalCode (optionally)
|
||||
- SteamTradeToken (optionally)
|
||||
- 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.
|
||||
```
|
||||
|
||||
### Additional info
|
||||
|
||||
<!-- Everything else you consider worthy that we didn't ask for. -->
|
||||
---
|
||||
name: Bug report
|
||||
about: Unexpected program behaviour that needs code correction
|
||||
title: ''
|
||||
labels: Bug, Evaluation
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
I fully read and understood contributing guidelines of ASF available under https://github.com/JustArchiNET/ArchiSteamFarm/blob/master/.github/CONTRIBUTING.md and I believe that my issue is valid - it requires a response from ASF development team, and not ASF support.
|
||||
|
||||
I understand that if my issue is not meeting contributing guidelines specified above, especially if it's a question or technical issue that is not related to ASF development in any way, then it will be closed and left unanswered.
|
||||
|
||||
Feel free to remove our notice and fill the template below with your details.
|
||||
-->
|
||||
|
||||
## Bug report
|
||||
|
||||
### Description
|
||||
|
||||
<!-- Short explanation of what you were going to do, what did you want to accomplish? -->
|
||||
|
||||
### Expected behavior
|
||||
|
||||
<!-- What did you expect to happen? -->
|
||||
|
||||
### Current behavior
|
||||
|
||||
<!-- What happened instead? -->
|
||||
|
||||
### Possible solution
|
||||
|
||||
<!-- Not mandatory, but you can suggest a fix/reason for the bug, if known to you. -->
|
||||
|
||||
### Steps to reproduce
|
||||
|
||||
<!-- Every command or action that happened after launching ASF, which leads to the bug. -->
|
||||
<!-- If launching ASF with provided configs (below) is everything that is needed, then this section is not mandatory. -->
|
||||
|
||||
### Full log.txt recorded during reproducing the problem
|
||||
|
||||
```
|
||||
Paste here, in-between triple backtick tags
|
||||
|
||||
Ensure that your log is complete and was NOT recorded in Debug mode, as debug log may contain sensitive information that should not be shared publicly, as per our the wiki. Standard ASF log does not include sensitive information.
|
||||
```
|
||||
|
||||
### Global ASF.json config (if using one)
|
||||
|
||||
```json
|
||||
Paste here, in-between triple backtick tags
|
||||
|
||||
Ensure that your config has redacted (but NOT removed) potentially-sensitive properties, such as:
|
||||
- IPCPassword (recommended)
|
||||
- SteamOwnerID (optionally)
|
||||
- WebProxy (optionally, if exposing private details)
|
||||
- WebProxyPassword (optionally, if exposing private details)
|
||||
- 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.
|
||||
```
|
||||
|
||||
### BotName.json config of all affected bot instances (if more than one)
|
||||
|
||||
```json
|
||||
Paste here, in-between triple backtick tags
|
||||
|
||||
Ensure that your config has redacted (but NOT removed) potentially-sensitive properties, such as:
|
||||
- SteamLogin (mandatory)
|
||||
- SteamPassword (mandatory)
|
||||
- SteamMasterClanID (optionally)
|
||||
- SteamParentalCode (optionally)
|
||||
- SteamTradeToken (optionally)
|
||||
- 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.
|
||||
```
|
||||
|
||||
### Additional info
|
||||
|
||||
<!-- Everything else you consider worthy that we didn't ask for. -->
|
||||
|
|
|
|||
82
.github/ISSUE_TEMPLATE/Feature_request.md
vendored
82
.github/ISSUE_TEMPLATE/Feature_request.md
vendored
|
|
@ -1,40 +1,42 @@
|
|||
---
|
||||
|
||||
name: Feature request
|
||||
about: General idea for improving the project
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
I fully read and understood contributing guidelines of ASF available under https://github.com/JustArchiNET/ArchiSteamFarm/blob/master/.github/CONTRIBUTING.md and I believe that my issue is valid - it requires a response from ASF development team, and not ASF support.
|
||||
|
||||
I understand that if my issue is not meeting contributing guidelines specified above, especially if it's a question or technical issue that is not related to ASF development in any way, then it will be closed and left unanswered.
|
||||
|
||||
Feel free to remove our notice and fill the template below with your details.
|
||||
-->
|
||||
|
||||
## Feature request
|
||||
|
||||
### Purpose
|
||||
|
||||
<!-- Purpose of the feature request - if it solves some problem, precise in particular what. If it benefits the program in some other way, precise in particular why. Present the underlying reason why this feature request makes sense, and what is the context of it. -->
|
||||
|
||||
### Solution
|
||||
|
||||
<!-- What would you like to see as a solution to the purpose specified by you above? What would work for you? -->
|
||||
|
||||
### Why currently available solutions are not sufficient?
|
||||
|
||||
<!-- If something you're suggesting is already possible, then explain to us why currently available solutions are not sufficient. If it's not possible yet, then explain to us why it should be. -->
|
||||
|
||||
### Does your suggestion fall into ASF scope?
|
||||
|
||||
<!-- Is ASF really the proper tool to include your enhancement in the first place? Is it connected with idling Steam cards? -->
|
||||
|
||||
### Is your suggestion abiding to Steam guidelines?
|
||||
|
||||
<!-- If not, it will not be considered. Please make sure that you're not suggesting anything potentially unwanted, botting Steam Market is just a single example of such thing - https://store.steampowered.com/subscriber_agreement / https://store.steampowered.com/online_conduct -->
|
||||
|
||||
### Additional info
|
||||
|
||||
<!-- Everything else you consider worthy that we didn't ask for. -->
|
||||
---
|
||||
name: Feature request
|
||||
about: General idea for improving the project
|
||||
title: ''
|
||||
labels: Enhancement, Evaluation
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
I fully read and understood contributing guidelines of ASF available under https://github.com/JustArchiNET/ArchiSteamFarm/blob/master/.github/CONTRIBUTING.md and I believe that my issue is valid - it requires a response from ASF development team, and not ASF support.
|
||||
|
||||
I understand that if my issue is not meeting contributing guidelines specified above, especially if it's a question or technical issue that is not related to ASF development in any way, then it will be closed and left unanswered.
|
||||
|
||||
Feel free to remove our notice and fill the template below with your details.
|
||||
-->
|
||||
|
||||
## Feature request
|
||||
|
||||
### Purpose
|
||||
|
||||
<!-- Purpose of the feature request - if it solves some problem, precise in particular what. If it benefits the program in some other way, precise in particular why. Present the underlying reason why this feature request makes sense, and what is the context of it. -->
|
||||
|
||||
### Solution
|
||||
|
||||
<!-- What would you like to see as a solution to the purpose specified by you above? What would work for you? -->
|
||||
|
||||
### Why currently available solutions are not sufficient?
|
||||
|
||||
<!-- If something you're suggesting is already possible, then explain to us why currently available solutions are not sufficient. If it's not possible yet, then explain to us why it should be. -->
|
||||
|
||||
### Does your suggestion fall into ASF scope?
|
||||
|
||||
<!-- Is ASF really the proper tool to include your enhancement in the first place? Is it connected with idling Steam cards? -->
|
||||
|
||||
### Is your suggestion abiding to Steam guidelines?
|
||||
|
||||
<!-- If not, it will not be considered. Please make sure that you're not suggesting anything potentially unwanted, botting Steam Market is just a single example of such thing - https://store.steampowered.com/subscriber_agreement / https://store.steampowered.com/online_conduct -->
|
||||
|
||||
### Additional info
|
||||
|
||||
<!-- Everything else you consider worthy that we didn't ask for. -->
|
||||
|
|
|
|||
Loading…
Reference in a new issue