From e8a1267c57a671bd33b9227ebda5d637c4a72a93 Mon Sep 17 00:00:00 2001 From: Michael Shilman Date: Fri, 12 May 2017 23:51:32 +1000 Subject: [PATCH 1/2] Document new issue labeling scheme --- CONTRIBUTING.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ae12b939906d..cec10e66c93b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,16 +33,16 @@ To test your project against the current latest version of storybook, you can cl ``` cd packages/react-storybook npm link - + cd npm link @kadira/storybook - + # repeat with whichever other parts of the monorepo you are using. ``` ### Reproductions -The best way to help figure out an issue you are having is to produce a minimal reproduction against the `master` branch. +The best way to help figure out an issue you are having is to produce a minimal reproduction against the `master` branch. A good way to do that is using the example `test-cra` app embedded in this repository: @@ -99,7 +99,16 @@ Issues that are tagged `question / support` or `needs reproduction` are great pl ### Triaging issues -Once you've helped out on a few issues, if you'd like triage access, you can help label issues, and respond to reporters. New issues should be labelled as one of `bug`, `new feature`, `question / support` or `discussion`. +Once you've helped out on a few issues, if you'd like triage access you can help label issues and respond to reporters. + +We use the following label scheme to categorize issues: +- **type** - `bug`, `feature`, `question / support`, `discussion`, `greenkeeper`, `maintenance`. +- **area** - `addon: x`, `addons-api`, `stories-api`, `ui`, etc. +- **status** - `needs reproduction`, `needs PR`, `in progress`, etc. + +All issues should have a `type` label. They should also have one or more `area`/`status` labels. We use these labels to filter issues down so we can easily see all of the issues for a particular area, and keep the total number of open issues under control. + +For example, here is the list of [open, untyped issues](https://github.com/storybooks/storybook/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20-label%3A%22bug%22%20-label%3A%22discussion%22%20-label%3A%22feature%22%20-label%3A%22maintenance%22%20-label%3A%22question%20%2F%20support%22%20-label%3A%22documentation%22%20-label%3A%22greenkeeper%22), or here is a list of [bugs that have not been modified since 2017-04-01](https://github.com/storybooks/storybook/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20label%3A%22bug%22%20updated%3A%3C%3D2017-04-01%20). For more info see [searching issues](https://help.github.com/articles/searching-issues/) in the Github docs. If an issue is a `bug`, and it doesn't have a clear reproduction that you have personally confirmed, label it `needs reproduction` and ask the author to try and create a reproduction, or have a go yourself. @@ -111,13 +120,12 @@ If an issue is a `bug`, and it doesn't have a clear reproduction that you have p - `bug`s should be closed when the issue is fixed and merged to `master` -- `new feature`s should be closed when merged or if the feature is deemed to be not appropriate. +- `feature`s should be closed when merged or if the feature is deemed to be not appropriate. - `question / support`s should be closed when the question has been answered. If the questioner drops offline, a reasonable period to wait is two weeks. - `discussion`s should be closed at a maintainer's discretion. - ## Development Guide > If you want to work on a UI feature, refer to the [Storybook UI](https://github.com/storybooks/storybook/tree/master/packages/storybook-ui) project. From 7f81fb8c99e1fcd20d9a461c02909e030b0014f7 Mon Sep 17 00:00:00 2001 From: Michael Shilman Date: Wed, 17 May 2017 00:56:25 +1000 Subject: [PATCH 2/2] Updated triage labels with more detail including merged label --- CONTRIBUTING.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cec10e66c93b..428de590204b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -106,7 +106,9 @@ We use the following label scheme to categorize issues: - **area** - `addon: x`, `addons-api`, `stories-api`, `ui`, etc. - **status** - `needs reproduction`, `needs PR`, `in progress`, etc. -All issues should have a `type` label. They should also have one or more `area`/`status` labels. We use these labels to filter issues down so we can easily see all of the issues for a particular area, and keep the total number of open issues under control. +All issues should have a `type` label. `bug`/`feature`/`question`/`discussion` are self-explanatory. `greenkeeper` is for keeping package dependencies up to date. `maintenance` is a catch-all for any kind of cleanup or refactoring. + +They should also have one or more `area`/`status` labels. We use these labels to filter issues down so we can easily see all of the issues for a particular area, and keep the total number of open issues under control. For example, here is the list of [open, untyped issues](https://github.com/storybooks/storybook/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20-label%3A%22bug%22%20-label%3A%22discussion%22%20-label%3A%22feature%22%20-label%3A%22maintenance%22%20-label%3A%22question%20%2F%20support%22%20-label%3A%22documentation%22%20-label%3A%22greenkeeper%22), or here is a list of [bugs that have not been modified since 2017-04-01](https://github.com/storybooks/storybook/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20label%3A%22bug%22%20updated%3A%3C%3D2017-04-01%20). For more info see [searching issues](https://help.github.com/articles/searching-issues/) in the Github docs. @@ -118,9 +120,9 @@ If an issue is a `bug`, and it doesn't have a clear reproduction that you have p - Unreproducible issues should be closed if it's not possible to reproduce them (if the reporter drops offline, it is reasonable to wait 2 weeks before closing). -- `bug`s should be closed when the issue is fixed and merged to `master` +- `bug`s should be labeled `merged` when merged, and be closed when the issue is fixed and released. -- `feature`s should be closed when merged or if the feature is deemed to be not appropriate. +- `feature`s, `maintenance`s, `greenkeeper`s should be labeled `merged` when merged, and closed when released or if the feature is deemed not appropriate. - `question / support`s should be closed when the question has been answered. If the questioner drops offline, a reasonable period to wait is two weeks.