issue labeling scheme

Hans Ekkehard Plesser edited this page Nov 29, 2016 · 8 revisions

Issue Labels

Each pull-request (PR) and issue is labeled along five "dimensions", each with its own color family:

To get an overview of how often each label is used go to the labels page.

Label Rules

  • the category letters ensure same order in issue list
  • only single label per category is allowed

C: Component

A component label specifies in which part of NEST the issue is located.

C: Kernel Kernel

  • changes in the NEST kernel

C: Documentation Documentation

  • Documentation updates, fixes, ...

C: Infrastructure Infrastructure

  • changes in the build system or CI scripts

C: Installation Installation

  • issues regarding the installation of NEST, e.g. on different platforms

C: Interpreter Interpreter

  • changes in the SLI iterpreter

C: Model Model

  • new or modified neuron or synapse models

C: PyNEST PyNEST

  • changes in the high level python interface of NEST

I: Interface

The interface label specifies if and where there are changes for users and/or developers.

I: User Interface User Interface

  • changes to the user interface

I: BehaviourChanges Behaviour changes

  • changes to the semantics of parameters or return values, while keeping the same API
  • changes in the effect of a method

I: External API External API

  • external API is what is defined in nest.h
  • change that requires users of NEST to change their code accordingly

I: Internal API Internal API

  • internal API is everything that is not external: Typically the kernel interfaces, managers, etc.
  • change that modifies the calls to functions not usually handled by users
  • NEST developers need to be aware about the new structure/parameters/methods...

I: No breaking change No breaking change

  • no change to any API that would break existing code
  • anything that compiled before should still compile afterwards

P: Progress

The progress label gives information about the status of the issue/PR. The normal work-flow would be pending -> in progress -> PR created (-> closed).

P: Blocked Blocked

  • work on this issue is not possible due to another issue
  • blocked by another PR that has to be merged first

P: PR Created PR Created

  • the issue advanced a lot, a solution exists and a corresponding pull request has been created

P: In Progress In progress

  • someone started and is actively working on this issue

P: Pending Pending

  • new issue where no-one has worked on yet

P: Reminder Reminder

  • nothing to be worked on, just to keep in mind. Typically goes together with T:Discussion.

S: Severity

S: Critical Critical

  • critical, bugs that need to be fixed asap.
  • needs to be fixed before the next release

S: High High

  • default priority for bugs, important enhancements

S: Low Low

  • default priority for everything but bugs, bugs that appear in very corner cases

T: Type

The type label specifies what this issue actually describes.

T: Bug Bug

  • bugs

T: External bug External bug

  • bugs that result from software outside, that we can not fix ourselves / that are beyond our control

T: Enhancement Enhancement

  • new/added features
  • anything that NEST couldn't do before

T: Maintenance Maintenance

  • refactoring
  • cleaning of unused NEST::Names

T: Discussion Discussion

  • ideas, wishlist, everything that needs comments from the community or has to be condensed to a more concrete plan

References

This scheme was inspired by

Clone this wiki locally
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.