Przeglądaj źródła

fix(docs): update style based on codacy feedback

Daniel Gibbs 7 lat temu
rodzic
commit
12bcc969e1

+ 12 - 8
.github/ISSUE_TEMPLATE/bug_report.md

@@ -22,18 +22,22 @@ Any general support issues on GitHub will be closed.
 
 *Please use the template below*
 
-## User Story
-As a [user description], I want [desired action] so that [desired outcome]
+# User Story
 
-## Basic info 
-- Distro [Ubuntu 18.04]
-- Game [Garry's Mod]
-- Feature [Monitor]
+As a [user description], I want \[desired action] so that \[desired outcome]
+
+# Basic info
+
+* 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.
 
-## To Reproduce
+# To Reproduce
+
 Steps to reproduce the behaviour:
 1. Go to '...'
 2. Click on '....'

+ 5 - 5
.github/ISSUE_TEMPLATE/feature_request.md

@@ -21,16 +21,16 @@ Any general support issues on GitHub will be closed.
 
 *Please use the template below*
 
-## User Story
-As a [user description], I want [desired action] so that [desired outcome]
+# User Story
+As a [user description], I want \[desired action] so that \[desired outcome]
 
-## Basic info 
+# Basic info 
 - Distro [Ubuntu 18.04]
 - Game [Garry's Mod]
 - Feature [Monitor]
 
-## Further Information
+# Further Information
 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.

+ 4 - 4
.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.
 
-## Is the server on Steam?
+# Is the server on Steam?
 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.