Skip to content

Pull Requests: Labeling guideline

Jump to bottom
Armel Soro edited this page Jun 19, 2023 · 2 revisions

Labelling rules for PRs

The use of one of the 5 labels below is necessary to ensure that changes appear in the changelog during release. It is the responsibility of OP and reviewers to ensure correct labelling.

  • kind/feature - A change that adds a new feature or deprecates/removes an existing one.

  • kind/bug - A bug is a defect in the tooling that needs to be fixed as soon as possible.

  • area/documentation - An issue for adding/removing/modifying the content from odo's website or any other documentation such as README.md, or CLI documentation for the odo commands.

  • area/refactoring - A code change that does not change any functionality, such as a refactor will belong here.

  • area/testing - Any change that relates to tests or the CI

You can base the label you apply on the primary goal of the PR. For example, feature changes will usually need to be accompanied by docs and test changes. But since the primary goal of this PR is to add a feature, you will apply kind/feature.

Clone this wiki locally