Difference between revisions of "Reporting Issues"

From /tg/station 13 Wiki
Jump to navigation Jump to search
(Created page with "If you ever encounter a bug in-game, the best way to let a coder know about it is with our [https://github.com/tgstation/-tg-station/issues Github issue tracker.] When creati...")
 
Line 5: Line 5:
 
If you have difficulty, ask for help in [[Community|#coderbus]]
 
If you have difficulty, ask for help in [[Community|#coderbus]]
 
== Issue Format ==
 
== Issue Format ==
  Server: Which server were you playing on?
+
Server: Which server were you playing on?
 
+
  Revision: What revision was the server running? Type 'show-server-revision' ingame to find out.
+
Revision: What revision was the server running? Type 'show-server-revision' ingame to find out.
 
+
  Problem Description: What is the problem?
+
Problem Description: What is the problem?
 
+
  What did you expect to happen: Why do you think this is a bug?
+
What did you expect to happen: Why do you think this is a bug?
 
+
  What happened instead: How is what happened different from what you expected?
+
What happened instead: How is what happened different from what you expected?
 
+
  Why is this bad/What are the consequences: Why do you think this is an important issue?
+
Why is this bad/What are the consequences: Why do you think this is an important issue?
 
+
  Steps to reproduce the problem: The most important section. Review everything you did leading up to causing the issue.
+
Steps to reproduce the problem: The most important section. Review everything you did leading up to causing the issue.
 
+
  Possibly related stuff (which gamemode was it? What were you doing at the time? Was anything else out of the ordinary happening?): Anything else you can tell us.
+
Possibly related stuff (which gamemode was it? What were you doing at the time? Was anything else out of the ordinary happening?): Anything else you can tell us.
  
 
[[Category:Guides]] [[Category:Game Resources]]
 
[[Category:Guides]] [[Category:Game Resources]]
 
{{Contribution guides}}
 
{{Contribution guides}}

Revision as of 12:43, 22 July 2014

If you ever encounter a bug in-game, the best way to let a coder know about it is with our Github issue tracker.

When creating a new issue it is important to use the format displayed below so coders can easily identify the problem.

If you have difficulty, ask for help in #coderbus

Issue Format

Server: Which server were you playing on?

Revision: What revision was the server running? Type 'show-server-revision' ingame to find out.

Problem Description: What is the problem?

What did you expect to happen: Why do you think this is a bug?

What happened instead: How is what happened different from what you expected?

Why is this bad/What are the consequences: Why do you think this is an important issue?

Steps to reproduce the problem: The most important section. Review everything you did leading up to causing the issue.

Possibly related stuff (which gamemode was it? What were you doing at the time? Was anything else out of the ordinary happening?): Anything else you can tell us.
Hosting Hosting a serverSetting up the databaseWorking with /tg/station as an upstream repository
Contributing Guide to contributing to the gameSetting up gitDownloading the source codeReporting issuesChangelogs
Coding Understanding SS13 codeSS13 for experienced programmersCode docsCoding standardsGetting Your Pull AcceptedBinary flags‎Text FormattingMySQL
Mapping Guide to mappingMap mergerGuide to door access
Spriting Guide to spritingResolving icon conflicts
Wiki Guide to contributing to the wikiWikicodeAutowiki