Labels
This article describes the labels as used in the API Blueprint GitHub Issues.
API Blueprint issues labels are divided into following categories:
- Priority
- Scope
- Status
- 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.
What is the most important issues at the moment.
The issue is a number one priority.
The issue is a second highest priority.
Scope of the issue. What area of the API Blueprint ecosystem is the issue about? Language itself or some of the tools?
The scope of the issue is the API Blueprint format itself or its implementation.
The scope of the issue is documentation of the API Blueprint (e.g tutorials, examples).
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.
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.
The scope of the issue is Aglio.
The issue isn't strictly related to the API Blueprint format itself but to the specific tooling.
The scope of this issue is neither of the previous scopes.
Status of the issue. Is it being worked on or is it waiting? If in progress where in the process the issue currently is.
The issue awaits input from its author - original poster.
The issue awaits for input and validation of the maintainer of API Blueprint.
The issue has been confirmed and awaits further actions depending on the type and the scope of the issue.
The issue is in the idea state.
The issue has an RFC proposed. See the API Blueprint RFC.
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).
The issue is being implemented in the API Blueprint parser stack.
The issue is being implemented in a API Blueprint tooling.
Works on the issue has been cancelled.
The type of the issue.
The issue is a question.
The issue is a new feature.
The issue is an improvement to existing feature.
The issue is a bug in existing feature.
