diff --git a/README.adoc b/README.adoc index 9c4956f97a..224d88ed87 100644 --- a/README.adoc +++ b/README.adoc @@ -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. +