github.com/Ilhicas/nomad@v1.0.4-0.20210304152020-e86851182bc3/contributing/issue-labels.md (about)

     1  # Nomad Issue Labels
     2  
     3  This document briefly describes the labels the Nomad team will apply when you
     4  open a GitHub issue. The workflows described here are a work-in-progress.
     5  
     6  ### Types
     7  
     8  Type labels define the workflow for an issue. See the description of the
     9  workflows below.
    10  
    11  Label | Description
    12  ---|---
    13  type/enhancement | Proposed improvement or new feature
    14  type/bug | Feature does not function as expected or crashes Nomad
    15  type/question | General questions
    16  
    17  ### Stages
    18  
    19  Triage labels define the stages of a workflow for an issue.
    20  
    21  Label | Description
    22  ---|---
    23  stage/accepted | The Nomad team intends to work on this bug or feature, but does not commit to a specific timeline. This doesn’t mean the design of the feature has been fully completed, just that we want to do so.
    24  stage/thinking | The Nomad team member who triages the issue needs a few days to think and respond to the issue
    25  stage/needs-discussion | This topic needs discussion with the larger Nomad maintainers group before committing to it. This doesn’t signify that design needs to be discussed.
    26  stage/needs-investigation | The issue described is detailed and complex. It will need some work and can't be immediately resolved.
    27  stage/waiting-reply | We need more information from the reporter.
    28  stage/not-a-bug | Reported as a bug but turned out to be expected behavior and was closed.
    29  
    30  ### Themes
    31  
    32  Theme labels define the component of Nomad involved. These will frequently
    33  change and new themes will be added for new features, so see the description
    34  of each label for details.
    35  
    36  ## Workflows
    37  
    38  ### `type/enhancement`
    39  
    40  When you as a community member make a feature request, a Nomad maintainer will
    41  triage it and generally label the issue as follows:
    42  
    43  * `stage/thinking`: The Nomad team member who triages the issue wants to think
    44    about the idea some more.
    45  * `stage/needs-discussion`: The Nomad team needs to discuss the idea within
    46    the larger maintainers group before committing to it.
    47  * `stage/waiting-reply`: The Nomad maintainer needs you to provide some more
    48    information about the idea or its use cases.
    49  * Closed: the Nomad team member may be able to tell right away that this
    50    request is not a good fit for Nomad.
    51  
    52  The goal for issue labeled `stage/thinking`, `stage/needs-discussion`, or
    53  `stage/waiting-reply` is to move them to `stage/accepted` (or to close
    54  them). At this point, you can submit a PR that we'll be happy to review, the
    55  Nomad maintainer who triaged the issue may open a PR, or for complex features
    56  it will get into the Nomad team's roadmap for scheduling.
    57  
    58  ### `type/bug`
    59  
    60  When you as a community member report a bug, a Nomad maintainer will triage it and generally label the issue as follows:
    61  
    62  * `stage/needs-investigation`: The Nomad maintainer thinks this bug needs some
    63    initial investigation to determine if it's a bug or what system might be
    64    involved.
    65  * `stage/waiting-reply`: The Nomad team member needs you to provide more
    66    information about the problem.
    67  * `stage/accepted`: The bug will need more than a trivial amount of time to
    68    fix. Depending on the severity, the Nomad maintainers will work on fixing it
    69    immediately or get it into the roadmap for an upcoming release.
    70  * `stage/not-a-bug`: The issue is not really a bug but is working as
    71    designed. Often this is a documentation issue, in which case the label may
    72    be changed to `type/enhancement` and `theme/docs`
    73  * Fixed! If the issue is small, the Nomad maintainer may just immediately open
    74    a PR to fix the problem and will let you know to expect the in the next
    75    release.