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

Readme: Clarify rule deprecation (#1446)

Browse Source
This commit is contained in:
Martin Strecker 2022-12-02 17:26:55 +01:00 committed by GitHub
parent 7e6b7ebe1d
commit 6888916f35
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.adoc
View File

@ -159,7 +159,9 @@ 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
* Fill in the `replacementRules` array with strings in the form `"RSPEC-xxxx"` with the rules that deprecate this one, if any
See link:rules/S1212/metadata.json[S1212] for an example.
==== To delete a rule
If the rule has never been implemented and is still defined in an open pull request, just close the pull request. +