Skip to content
ComicIronic edited this page Aug 7, 2016 · 13 revisions

Tagging guidelines

This is a guide on what tags mean and when to apply them.

##Tags In no particular order:

Balance

This tag belongs on any PR which changes the game balance of an item, ability, system, etc. It doesn't necessarily need to be balance regarding player vs. player interactions, it can be as simple as 'makes the autolathe faster'. Note that the addition of new content can have balance implications as well. Discussions about game balance also should have this tag.

Discussion

This tag should be used primarily on issues which are the basis for discussions such as brainstorming or gathering feedback. Also used for PRs that turn into debates.

Controversial

This tag should be applied to any PR or issue that the community cannot agree about. For example, if two equal groups cannot agree on if xenos are OP.

Gameplay/Gamemode

This tag applies primarily to PRs that alter the overarching design of the game (economy, departmental overhauls/additions/removals)

Bug/Fix

Issues with this tag document bugs, and PRs with this tag fix bugs.

Oversight

Issues with this tag involve cases where the code is functioning correctly but interaction of objects is producing emergent bad behaviour that should be fixed.

What's the difference?

Bugs are code issues - they can be anything from poorly written logic to a lack of sanity, but they mean that the code doesn't do what the writer expects it to. Oversights are not caused by bad code - they are caused by code interaction, when two systems come together to do something that we expect in each system, but together are an issue.

Runtime Log

Issues with this tag document runtimes with included runtime logs. PRs should probably not be tagged with this, but if they are it's because they're fixing related issues with runtimes.

Needs Review

This tag describes PRs that need code review by one or more experienced coders to check for flaws in the code itself.

Needs Final Decision

This tag means that the PR has been reviewed by one or more people, but has been left open due to other concerns (controversy, for example)

DO NOT MERGE

This tag is used to describe PRs that have flaws that should prevent them from being merged before they are fixed.

Needs Fixing

Largely redundant with Do Not Merge, mainly useful for things like WIP PRs.