GitHub Labelling Guide

On this page

Contributors with appropriate permissions on the Polypheny-DB repository can assist by assigning labels to issues and pull requests.

Issues

These are the primary labels used for issues:

  • Yellow, A-prefixed labels illustrate which part of the project an issue pertains to. These labels help to categorize issues for easy tracking and assignment. Examples include: A-core, A-ui, A-stores.

  • Light purple, C-prefixed labels categorize the issue. The categories can be varied such as bug, feature, documentation, or any other types relevant to the project.

  • Green, E-prefixed labels identify the level of experience needed to address the issue. This helps in assigning issues to developers with suitable experience levels. Labels might include E-beginner, E-intermediate, E-expert.

  • Light orange invalid label is used to mark issues that have been opened in error. This is used to filter out any unnecessary or irrelevant issues.

  • Orange, P-prefixed labels denote an issue’s priority. They help in prioritizing tasks for developers. Examples can be P-high, P-medium, P-low.

  • Gray, S-prefixed labels track the status of pull requests. They help in managing the workflow and progression of PRs.

Pull Requests

These are the primary labels used for pull requests:

  • S-waiting-on-review: This label means the pull request is ready for review. If your PR is not ready for review, consider marking it as a draft pull request.

  • S-waiting-on-author: This label indicates that the pull request requires further changes or input from the author.

Additional labels for pull requests include:

  • S-blocked: This label denotes that some issues or dependencies are preventing this pull request from being merged. When you assign this label, please also add a comment detailing the blocking issue, especially if there’s a related issue that can be referenced.

  • S-inactive: Use this label when there’s been a lack of activity for a significant time. This helps identify stale PRs that might require additional attention or follow-up.

By utilizing these labels effectively, the management of issues and pull requests becomes efficient and well-organized.

Credits: This labeling scheme is adapted from the one used by the Rust language.
© Polypheny GmbH. All Rights Reserved.