Skip to content

About

Documentation and synchronization utilities for issue and pull request labels used across our projects.

Resources

Code of conduct

Contributing

Security policy

Stars

3 stars

Watchers

3 watching

Forks

Repository files navigation

Preview our labels on this page.

Issue Labels

This documents our usage of issue labels across bpmn.io and related projects.

In our projects we build upon a set of default labels and define a framework for custom, per-repository labels.

General guidelines

  • Labels add important additional meta-data, we don't overuse them
  • We are label less per default (no low priority or task labels)
  • We use colors to group labels semantically

Default labels

labels-default.yml defines labels that are available out of the box, across all our repositories.

Automatic synchronization

# fetch issue view via our task board
curl https://tasks.bpmn.io/wuffle/board/cards > issues.json

# execute the label sync utility:
ACCESS_TOKEN=ghp_PERSONAL_ACCESS_TOKEN_WITH_REPO_SCOPE node index.js

# for debugging purposes run it in `DRY_RUN` mode
DRY_RUN=1 ACCESS_TOKEN=ghp_PERSONAL_ACCESS_TOKEN_WITH_REPO_SCOPE node index.js

You can also replace the PAT with a token generated by gh:

# execute the label sync utility:
ACCESS_TOKEN=$(gh auth token) node index.js

# for debugging purposes run it in `DRY_RUN` mode
DRY_RUN=1 ACCESS_TOKEN=$(gh auth token) node index.js

Custom labels

labels-additional.yml showcases some custom labels. Those may be added to individual repositories to reflect domain specific aspects.

We use color for semantic grouping of important aspects, within a repository, but also across repository boundaries.

What Example Color Preview
Theme / feature cluster ux, a11y, modeling, refactoring actions #0E8A16 a11y
Domain { BPMN, DMN, FORM }, { Camunda Platform, Camunda Cloud } #4369a0 Camunda Platform
Environment browsers = { IE, Edge, Safari }, os = { Windows, MacOS, Darwin } #e2a465 browser:IE

About

Documentation and synchronization utilities for issue and pull request labels used across our projects.

Resources

Code of conduct

Contributing

Security policy

Stars

3 stars

Watchers

3 watching

Forks

Used by

Contributors

Languages