Skip to content
Martin von Gagern edited this page Oct 8, 2016 · 2 revisions

This table details the meaning the CindyJS project associates with the different labels for issues and pull requests on GitHub. Any new label should be added to this list with a suitable explanation.

Kind of issue

  • bug: Code does not exhibit documented or intended behavior
  • Cinderella compat.: CindyJS behaves different from Cinderella
  • enhancement: New feature or similar improvement
  • question: For questions about the project, e.g. about how to perform a given task
  • discussion: For general discussion of possible approaches to certain problems (pull requests with this label are not meant to be merged without discussion)

Issues which affect the core executable code should usually fall into one of these categories. Issues which deal with documentation, build system, unit tests or similar need not use one of these tags.

Affected component

  • documentation: Changes to the documentation (including ref tests)
  • plugins: Affects the plugin infrastrtucture in general, or a plugin which has no more specific tag
  • Specific plugins: Cindy3D, CindyGL and ComplexCurves

Impact

  • incompatible: modified code is (expected to be) incompatible with current releases, will require major version bump
  • mc²: Needed for the M C Squared Project

Status

  • help wanted: Contributors are welcome to provide input (if pull request or assigned issue) or even take care of this (if unassigned issue)
  • duplicate: Described issue is handled in some other ticket, which should be mentioned in a comment near the point where this label was added
  • invalid: The problem report is invalid: problem outside CindyJS' scope, or cannot be reproduced, or similar
  • wontfix: The issue will not be resolved, for reasons indicated in the comments.
  • rebased: The pull request may appear closed without merging, but in fact a rebased version of it got merged