Skip to content
Wizardcrying edited this page Dec 30, 2016 · 13 revisions

Tagging guidelines

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

##Tags In alphabetical order:

100% Tested

Hahaha they didn't test shit.

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.

Bug/Fix

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

Compile Failure

Pretty self explanatory, the code in question doesn't compile.

Conflicts

This PR is conflicting with another PR or commit that has already been pushed.

Consistency Issue

This is mainly used where there's two similar systems/objects but one is missing a behavior expected of it since the other has it.

Content

Adds something new!

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.

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.

DO NOT MERGE

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

Easy Fix

This is applied to issues that someone who is just starting out at coding on BYOND should be able to figure out fairly simply, albeit possibly with a bit of help if they're new to coding altogether.

Exploitable

As-is, the issue described or something added in the PR is exploitable by malcontents in the playerbase. Needs fixing ASAP.

Feature Loss

Something that used to be there but is now gone.

Feature Request

Something that someone is asking be coded that likely doesn't exist yet. Replaced by the tag "WYCI" when it applies.

File Cleanup

Bringing code up to standards without actually changing anything (or much, depending on what's changing) on the game side of things. Can also be applied to someone sorting DMIs by icon_state or whatever.

Gameplay/Gamemode

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

Goonchat

This issue/PR is in relation to the chat system we're currently using.

Grammar / Formatting

Complains about words (issues) or changes words (PR).

Honk

Honk.

Hotfix

Fixes something that isn't quite what it was expected to be when it was pushed recently.

IT'S A FEAAAATUUUUREEEEEEEEE

Something that may or may not stay around even if it may not make logical sense. Also known as "too funny to fix".

Logging / Administration

Anything that involves game logging or administration tools.

Mapping (Map name goes here)

Modifies / Requests modification of the named map.

Mapping (General)

Modifies every major map we actually use, or requests that something be changed on them all. Please apply WITH the individually named maps for purposes of tag searching. Can also be used on something that modifies maps that don't fit any other category, such as a new one.

Mapping Priority

This PR needs to be merged before anything else that touches the maps so that they don't have to deal with conflict hell.

Muh Immulsions

Someone's immersions were shattered, oh dear.

Needs Changelog

Add a changelog.

Needs Fixing

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

Needs More Testing

If applied to an issue, then it's unclear as to the cause. If it's applied to a PR, clearly it needs to be tested more before being merged to ensure that it actually functions.

Needs Pics / Needs Moar Info

Someone didn't give much information at all when they made an issue.

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 Spritework

Spriters assemble.

Not a Bug

The issue isn't a bug. However, it may still need fixing or adjustment.

OH GOD IT'S LOOSE

FIXITFIXITFIXITFIXITFIXITFIXITFIXITFIXITFIXITFIXITFIXITFIXIT

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 between Oversight and Bug/Fix?

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.

Parallax

Pertains to the Parallax system.

Performance

Either negatively or positively impacts performance of the server.

Port

This was taken from another server.

❤️ QUALITY ❤️

Making things better for everyone.

Requires Server Vote

An admin needs to run a server vote and figure out what the playerbase thinks about this change.

Runtime Log

Issues with this tag document runtimes with included runtime logs. It's perfectly fine to also tag PRs that fix said issues with this.

Sanity / Ghosthands

Someone can do something they shouldn't be able to.

Secret Repo Conflict

Someone with secret repo access will have to update the secret repo after this is merged in order for it to function correctly. This tag will AUTOMATICALLY be applied by PJB's bot, however please remove it (even after the PR is merged) when you resolve the conflict.

Sound

Pew pew.

Sprites

Pretty colors.

System

This means something that works behind the scenes. This may or may not affect the average player when modified.

T-Thanks BYOND

This'll take a lot of work to work around, or it's unfixable.

UI

This means the things you can see that aren't IC, such as your inventory, HUDs, health, etc.

Unable to Reproduce

Someone can't reliably reproduce this issue when they follow the steps provided.

Update Wiki

Update the wiki either before or after the merge.

WYCI

When You Code It. A feature request that (probably) nobody will code for you.