Skip to content

Issue & Pull Request labels

Sparkling Comet edited this page Aug 25, 2017 · 2 revisions

Most Pull-Requests (PR) and issues are given labels that serve the purpose of keeping everything clean and simple. The tag names give the user a short but clear description of the purpose of the PR/issue, which show what is missing and what the thread is for to end users, external collaborator and members of the dev team.

This form of metadata speeds up the work immensely and permits faster feature implementations and patches/bug fixes to be released. Below is a list of all (current) labels, their description and use.

Usage

Announcement

Issues

Is applied role issues that are usually locked and simply serve the purpose of spreading information and news.

This flag is usually reserved to members of the dev team.

An example of the usage for this label is issue #23.

PRs

N/A

Bug

Issues

Is used to identify issues opened by end users, external collaborators or official dev team users that contain bug reports and/or request patches.

PRs

Is used to warn the community and international collaborators about bugs and similar issues inside and PR.

Is often used in conjunction with the on hold/rejected labels.

Cleanup

PRs

Marks PRs that represent an attempt of improving the code quality or performance without changes I'm the program's semantics.

Issues

N/A

Duplicate

PRs

Labels duplicate PRs.

Issues

Labels duplicate issues.

Enhancement

PRs

Is applied to requests merging of an implementation for an enhancement of an already existing feature.

Issues

Is applied to requests of enhancements of already existing features.

Experimental

PRs

Marks pull-requests with new, not sufficiently tested features (BETA).

The label is supposed to be removed once the feature has reached enough tests and is no longer in BETA stage.

Issues

N/A

Feature

PRs

Is applied to PRs that want to merge changes containing new features.

Usually, when such a PR is merged, a minor update is released, which means that the second digit in the versioning string (x.Y.z-BUILD) is increased while the third one is reset.

Issues

Is applied to issues containing new feature suggestions.

Fix

PRs

Labels PRs which are proposing patched that attempt to fix one or more bug.

Issues

N/A

Help wanted

PRs

Identifies PRs that need testing, reviewing or other kind of feedback by the community and the dev team.

Issues

Identifies issues containing questions from people.

Incomplete

PRs

Marks PRs that are not complete. Usually, incomplete PRs are submitted because the collaborator is in need of feedback or simply wishes to show what they are working on.

This label is often used in conjunction with the on hold label.

Issues

N/A

Needs testing

PRs

Identifies PRs which have not been tested enough yet.

Is often used in conjunction with needs help and on hold.

Issues

N/A

On hold

PRs

Is applied to PRs which are considered in hold (speaking in terms of the reviewing/approval process) because they require another PR to be implemented first, or because the author requested it to be marked as such because of delays in patching one or more problems.

Issues

N/A

Rejected

PRs

Marks PRs which go beyond scope or fail to patch issues/comply with the project's standards.

Sometimes used in with the more specific duplicate tag.

Issues

Marks issues which go beyond scope or contain other problems which do propose impossible suggestions.

Sometimes used in with the invalid label, as well as the (deprecated) wontfix label and the more specific duplicate tag.

Wiki Index

Downloads

  • You may download the latest version here.
  • You may clone the source with the command git clone https://github.com/TradeShop/TradeShop.git
  • You may also clone the whole wiki to your computer with the command git clone https://github.com/TradeShop/TradeShop.wiki.git.

Contact

You may contact the developers for any reason on Discord or on GitHub.

License

The entire project is licensed under the Apache License v2.0.

Clone this wiki locally