Jun 22, 2018

Bug Report Best Practices & Terms

0 comments

Edited: Jun 22, 2018

 

Bug Writing Best Practices:

 

Research:

- What was the issue you ran into?

- What part of the game were you in?

- Are you able to reproduce the issue? If so, what is the occurrence? 3/5, 5/5?

- How widespread is the issue? Does it occur with multiple units, areas of the UI? Does it happen for the host or client?

- Can you narrow down the steps to reproduce?

- What steps have you taken to try and correct the issue?

 

Writing:

- Try to be as clear and concise as you can. 

- Reference any relevant units, abilities, UI elements, AI behavior, etc

 

Terminology to help describe areas of the game:

UI (User interface)

Main Menu

Waiting for Players Screen (Host only)

Loading Screen

Strategy Picker (where you develop and choose your units)

- Development Menu

- Unit Selection Menu, Hero/Escort tab

- Strategy Picker map

Conflict Phase (where the conflicts are listed)

Action Phase/Gameplay (where you control your hero in combat)

Results Screen (shows which control points were taken)

Domination/Termination Screen (End game screen to show victory/defeat)

HUD (can be seen in both the Strategy Picker and in gameplay. Top bar, Hero Icon and Minimap included)

Hero: This is the unit you control.

Escort: This is the AI that you choose alongside your Hero in the Strategy Picker. You can pick them out on the battlefield as the AI that is following you around.

Army: This is your AI teammate's units. 

Control Point 

Volcano Arena

Expansion (enemy or your own) - additional arenas

 

Bugs Types:

Crash - The game stops responding and closes unexpectedly

Gameplay - Consider this when you are in control of your Hero

Collision - Areas that you're able to get out of bounds or is difficult to path through or get stuck on

AI - AI behaving in an unexpected or weird ways

Camera 

Text - grammar, misspellings, placeholder text, etc

Network - Disconnections, out-of-sync behavior between players or AI. Be sure not confuse performance issues with a low ping. Be sure to note the ping of the game before you join a match.

Performance - Or Frame Rate. If you run into a performance issue please provide information about your PC Specs in Notes section of the bug and include your dxdiag information if possible.

Art - Missing textures, incorrect team color, z-fighting issues (two textures flickering back and forth)

UI - Any menu systems

New Posts
  • You don't have to follow this template, but it helps in dissecting what actually happened to you so we can quickly and easily fix the issue. ---------------------------- Template: Title: Repro Steps (How it occurred): 1)  2) 3) 4) 5) Results: Repro Rate (How often it happens): -/5 Notes: Files: ---------------------------- Made up example bug: Title: Using the Hydra's flame thrower causes performance issues Repro Steps: 1) In the development panel select "Tech"  2) Select Hydra as your Hero unit and proceed to gameplay 3) When in game right click to use the Flame Thrower Results: Framerate drops  Repro Rate: 5/5 Notes: This issue occurs regardless of the number of units, buildings on screen or what arena that I'm in.  System information:       System Manufacturer: Gigabyte Technology Co., Ltd.              System Model: Z87X-HD3                 Processor: Intel(R) Core(TM) i7-4770K CPU @ 3.50GHz (8 CPUs), ~3.5GHz Graphics: NVIDIA GeForce GTX 660                    Memory: 8192MB RAM       Available OS Memory: 8144MB RAM                 Page File: 7982MB used, 10914MB available           DirectX Version: DirectX 12 Files: DxDiag.txt