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

RULEAPI-602 Describe the procedure of deprecating a rule

Browse Source
This commit is contained in:
Amélie Renard 2021-05-05 09:44:23 +02:00 committed by GitHub
parent 0152ebc324
commit 68900c9066
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.adoc
View File

@ -55,6 +55,21 @@ In the subject add the following text:
Modify rule Sxxxx
----
==== To deprecate a rule
Create a branch for the deprecation manually.
Then open a pull request manually.
In the subject add the following text:
----
Deprecate rule Sxxxx
----
In the `metadata.json` of the rule you want to deprecate:
* Remove all tags
* Remove all quality profiles
* Change the status to `deprecated`
* Fill in the `replacementRules` field with the rules that deprecate this one, if any
NOTE: use a GitHub hot-key `t` in the source view to navigate to an existing rule specification.
=== 2. Edit the pull request