Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Priority is vague, and can mean different things depending on issue type. Beam uses 5 levels of severity; they may correspond to "P0" through "P4" in other systems. You can think of them like this:

  • P0 Blocker: get paged, stop whatever you planned on doing, work late to fix
  • P1 Critical: continually update everyone on status and shouldn't sit around unassigned
  • P2 Major: most things here; they are important but not an interrupt - if unsure, use Major and someone from the community will review the details
  • P3 Minor: nice-to-have things, may not make it onto regular planning and roadmapping but still useful if someone wants to do it
  • P4 Trivial: a special category for typos or minor cleanups that might be good for newcomers just to get started with the project, build system, etc

Components

A list of all Beam components and their descriptions can be found in the components page for the project. These components correspond to different areas within the Beam project and all issues should be filed in one or more relevant components. For this reason, contributors should review the components page and have a basic familiarity with the components of the project.

...

A label is an arbitrary text string attached to an issue. Labels are used to tag issues for searches, and are usually used to identify aspects of an issue that are not directly related to code. Beam has a few labels that are used systematically:

  • starter - means that this it is a good task to get started contributing to Beam.
  • triaged - means that an experienced member of the community has reviewed the component, priority, issue type, and that someone who understands the issue has been contacted. Do not add this label to new issues or no one will look at it.
  • sickbay - means that the Jira is about a test that was disabled because it was broken, and it should be fixed and re-enabled
  • flake - means the Jira is about a test that is flaky so it harms everyone's productivity, a non-sickbayed flake must always be Critical priority or higher

Contributors are encouraged to label issues in whatever other ways they want. However, there are no expectations or requirements regarding labels so too much consistency should not be expected.

...