From 4f1d739cbaeb716f2d1f8f18e1528b43df666124 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Am=C3=A9lie=20Renard?= <44666826+amelie-renard-sonarsource@users.noreply.github.com> Date: Mon, 7 Jun 2021 16:45:47 +0200 Subject: [PATCH] README: Explain labels (#100) --- README.adoc | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.adoc b/README.adoc index dc146a833b..83e13e729f 100644 --- a/README.adoc +++ b/README.adoc @@ -105,6 +105,7 @@ Add a short summary of the PR after the required prefix. For example: ---- Modify rule S1234: Allow tail recursion for languages supporting TCO ---- +Add at least one label corresponding to the language(s) the PR relates to. ==== To deprecate a rule Create a branch for the deprecation manually. @@ -113,6 +114,7 @@ In the subject add the following text: ---- Deprecate rule Sxxxx ---- +Add at least one label corresponding to the language(s) the PR relates to. In the `metadata.json` of the rule you want to deprecate: @@ -171,6 +173,11 @@ you have to run `update` immediately after, because rule-api relies on the files in the directory to determine the covered set of rules when generating the deprecation notes for superseded rules. +== Untriaged Pull Requests + +Untriaged PRs are the ones without any label. You can easily see all of them with the filter [`Label > Unlabeled`](https://github.com/SonarSource/rspec/pulls?q=is%3Aopen+is%3Apr+no%3Alabel). + +All triaged PRs should have at least one label that corresponds to the bubble(s) the PR is related to. This allows bubbles to easily filter out the PRs they are interested in. + == Tooling https://github.com/SonarSource/rspec/tree/master/rspec-tools[rspec-tools]:: A python CLI tool for adding and validating rules. It is used by GitHub checks and GitHub actions.