Z edited this page Dec 2, 2015 · 12 revisions

API Blueprint Issue Labels

This article describes the labels as used in the API Blueprint GitHub Issues.

API Blueprint issues labels are divided into following categories:

  1. Priority
  2. Scope
  3. Status
  4. Type

Any issue MAY have up to ONE label from a given category associated.

The labels should be read as follows:

"The issue is a bug within the Apiary.io tooling currently being fixed in this tooling."

"The issue is a new feature of the API Blueprint format currently being in the RFC process. This issue is the next most important issue."

Below you can find the description of labels in use.

1. Priority

What is the most important issues at the moment.

The issue is a number one priority.

Next

The issue is a second highest priority.

2. Scope

Scope of the issue. What area of the API Blueprint ecosystem is the issue about? Language itself or some of the tools?

Language

The scope of the issue is the API Blueprint format itself or its implementation.

Documentation

The scope of the issue is documentation of the API Blueprint (e.g tutorials, examples).

Apiary.io

The scope of the issue is Apiary.io.

The issue isn't strictly related to the API Blueprint format itself but to the specific tooling.

Dredd

The scope of the issue is the Dredd testing tool.

The issue isn't strictly related to the API Blueprint format itself but to the specific tooling.

Aglio

The scope of the issue is Aglio.

The issue isn't strictly related to the API Blueprint format itself but to the specific tooling.

Other

The scope of this issue is neither of the previous scopes.

3. Status

Status of the issue. Is it being worked on or is it waiting? If in progress where in the process the issue currently is.

Awaiting Input

The issue awaits input from its author - original poster.

Awaiting Validation

The issue awaits for input and validation of the maintainer of API Blueprint.

Confirmed

The issue has been confirmed and awaits further actions depending on the type and the scope of the issue.

Idea

The issue is in the idea state.

RFC

The issue has an RFC proposed. See the API Blueprint RFC.

Spec Implementation

The issue is in the state of specification implementation. For example when a API Blueprint specification is being worked on for a new language feature (with RFC in place).

Parser Implementation

The issue is being implemented in the API Blueprint parser stack.

Tooling Implementation

The issue is being implemented in a API Blueprint tooling.

Cancelled

Works on the issue has been cancelled.

4. Type

The type of the issue.

Question

The issue is a question.

Feature

The issue is a new feature.

Improvement

The issue is an improvement to existing feature.

Bug

The issue is a bug in existing feature.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.