Skip to content

Pull Requests: Labeling guideline

Charlie Drage edited this page Feb 1, 2022 · 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. Missing one of these on your PR means it won't show up in the changelog/release notes. It is the responsibility of OP and reviewers to ensure correct labelling.

  • kind/bug - A bug is a defect in the tooling that needs to be fixed as soon as possible.
  • kind/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.
  • kind/cleanup - A code change that does not change any functionality, such as a refactor will belong here.
  • kind/feature - A change that adds a new feature or deprecates/removes an existing one.
  • kind/tests - Any change that relates to tests or the CI

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

If you are creating a debug PR or are closing one for any reason (not merging it), make sure to remove the kind label you applied from it to ensure it does not show up in the changelog

Clone this wiki locally