ishangsf/rspec
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

README: Explain labels (#100)

Browse Source
This commit is contained in:
Amélie Renard 2021-06-07 16:45:47 +02:00 committed by GitHub
parent 1ffcd727ee
commit 4f1d739cba
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.adoc
View File

@ -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.