Difference between revisions of "Reporting Issues"

From Yogstation-13
Jump to: navigation, search
m (Removed an unnecessary link. Mixed up the order of the questions, someone who has gone through the trouble to get here shouldn't be first pestered with off-putting show-revision -questions, have them explain the problem first.)
Line 1: Line 1:
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.]
+
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/new GitHub Issue Tracker].
  
When creating a [https://github.com/tgstation/-tg-station/issues/new new issue] it is important to use the format displayed below so coders can easily identify the problem.
+
(If you don't have an account, making a new one takes only one minute.)
 +
 
 +
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 [[Community|#coderbus]].
  
If you have difficulty, ask for help in [[Community|#coderbus]]
 
 
== Issue Format ==
 
== Issue Format ==
  Server: Which server were you playing on?
+
  '''Problem Description:''' What is the problem?
 +
 +
'''What did you expect to happen:''' Why do you think this is a bug?
 
   
 
   
  Revision: What revision was the server running? Type 'show-server-revision' ingame to find out.
+
  '''What happened instead:''' How is what happened different from what you expected?
 
   
 
   
  Problem Description: What is the problem?
+
  '''Why is this bad/What are the consequences:''' Why do you think this is an important issue?
 
   
 
   
  What did you expect to happen: Why do you think this is a bug?
+
  '''Steps to reproduce the problem:''' The most important section. Review everything you did leading up to causing the issue.
 
   
 
   
  What happened instead: How is what happened different from what you expected?
+
  '''Server:''' Which server were you playing on?
 
   
 
   
  Why is this bad/What are the consequences: Why do you think this is an important issue?
+
  '''Revision:''' What revision was the server running? Type 'show-server-revision' ingame to find out.
 
   
 
   
  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.
+
  '''Thanks for helping us out!'''
 +
 
  
 
[[Category:Guides]] [[Category:Game Resources]]
 
[[Category:Guides]] [[Category:Game Resources]]
 
{{Contribution guides}}
 
{{Contribution guides}}

Revision as of 06:43, 23 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.

(If you don't have an account, making a new one takes only one minute.)

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

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.

Server: Which server were you playing on?

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

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.

Thanks for helping us out!
Contribution guides
General Hosting a server, Setting up git, Downloading the source code, Guide to contributing to the game, Reporting issues, Game resources category, Guide to changelogs
Database (MySQL) Setting up the database, MySQL
Coding Coding standards, Understanding SS13 code, SS13 for experienced programmers, Binary flags‎, Getting Your Pull Accepted, Guide to SNPC's, Text Formatting
Mapping Guide to mapping, Room Structure, Map merger
Spriting Guide to spriting
Wiki Guide to contributing to the wiki, Wikicode