Browse Source

fix(docs): update style based on codacy feedback

pull/2151/head
Daniel Gibbs 6 years ago
parent
commit
12bcc969e1
  1. 20
      .github/ISSUE_TEMPLATE/bug_report.md
  2. 10
      .github/ISSUE_TEMPLATE/feature_request.md
  3. 8
      .github/ISSUE_TEMPLATE/new-server-request.md

20
.github/ISSUE_TEMPLATE/bug_report.md

@ -22,18 +22,22 @@ Any general support issues on GitHub will be closed.
*Please use the template below* *Please use the template below*
## User Story # User Story
As a [user description], I want [desired action] so that [desired outcome]
## Basic info As a [user description], I want \[desired action] so that \[desired outcome]
- Distro [Ubuntu 18.04]
- Game [Garry's Mod] # Basic info
- Feature [Monitor]
* Distro [Ubuntu 18.04]
* Game [Garry's Mod]
* Feature [Monitor]
# Further Information
## Further Information
A clear description of what the bug is and any ideas on how to resolve it. Plus any further context that might be relevant to the issue. A clear description of what the bug is and any ideas on how to resolve it. Plus any further context that might be relevant to the issue.
## To Reproduce # To Reproduce
Steps to reproduce the behaviour: Steps to reproduce the behaviour:
1. Go to '...' 1. Go to '...'
2. Click on '....' 2. Click on '....'

10
.github/ISSUE_TEMPLATE/feature_request.md

@ -21,16 +21,16 @@ Any general support issues on GitHub will be closed.
*Please use the template below* *Please use the template below*
## User Story # User Story
As a [user description], I want [desired action] so that [desired outcome] As a [user description], I want \[desired action] so that \[desired outcome]
## Basic info # Basic info
- Distro [Ubuntu 18.04] - Distro [Ubuntu 18.04]
- Game [Garry's Mod] - Game [Garry's Mod]
- Feature [Monitor] - Feature [Monitor]
## Further Information # Further Information
A clear description of what the feature is and any ideas on how to achieve this. A clear description of what the feature is and any ideas on how to achieve this.
## Further Reading # Further Reading
Provide any useful documentation or resources that might help. Provide any useful documentation or resources that might help.

8
.github/ISSUE_TEMPLATE/new-server-request.md

@ -4,13 +4,13 @@ about: Suggest a new game server to be added
--- ---
## What game server would you like adding? # What game server would you like adding?
## Can you link to any tutorials or guides? # Can you link to any tutorials or guides?
Provide any useful documentation or resources that might help. Provide any useful documentation or resources that might help.
## Is the server on Steam? # Is the server on Steam?
If yes Use SteamDB to get the appid. (https://steamdb.info) If yes Use SteamDB to get the appid. (https://steamdb.info)
## Is the server supported on Linux? # Is the server supported on Linux?
We only support Linux servers and do not support Wine. We only support Linux servers and do not support Wine.

Loading…
Cancel
Save