From 4f6aeaa6347725436296131c4d2b059243390a04 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Tue, 28 Oct 2014 17:41:25 -0700 Subject: [PATCH] Add labels explanation to readme --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index a885a9ba97..99ff3c222f 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,7 @@ To get started, check out ! - [Documentation](#documentation) - [Contributing](#contributing) - [Community](#community) +- [Issues and labels](#issues-and-labels) - [Versioning](#versioning) - [Creators](#creators) - [Copyright and license](#copyright-and-license) @@ -104,6 +105,26 @@ Keep track of development and community news. +## Issues and labels + +Our bug tracker utilizes several labels to help organize and identify issues. Here's what they represent and how we use them: + +- `browser bug` - Issues that are reported to us, but actually are the result of a browser-specific bug. These are diagnosed with reduced test cases and result in a issue opened on that browser's own bug tracker. +- `confirmed` - Issues that have been confirmed with a reduced test case and idenfity a bug in Bootstrap. +- `css` - Issues stemming from our compiled CSS or source Less files. +- `customizer` - Issues with our web-based Customizer. +- `docs` - Issues for improving or updating our documentation. +- `examples` - Issues involving the example templates included in our docs. +- `feature` - Issues asking for a new feature to be added, or an existing one to be extended or modified. New features require a minor version bump (e.g., `v3.0.0` to `v3.1.0`). +- `grunt` - Issues with our included JavaScript-based Gruntfile, which is used to run all our tests, concatenate and compile source files, and more. +- `help wanted` - Issues we need or would love help from the community to resolve. +- `js` - Issues stemming from our compiled or source JavaScript files. +- `meta` - Issues with the project itself or our GitHub repository. + +For a complete look at our labels, see the [project labels page](/twbs/bootstrap/labels). + + + ## Versioning For transparency into our release cycle and in striving to maintain backward compatibility, Bootstrap is maintained under [the Semantic Versioning guidelines](http://semver.org/). Sometimes we screw up, but we'll adhere to those rules whenever possible.