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

RULEAPI-623: Update README

Browse Source
This commit is contained in:
Amélie Renard 2021-06-09 08:35:31 +02:00 committed by GitHub
parent 5992534c55
commit debc5071c3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.adoc
View File

@ -13,7 +13,8 @@ It also contains rules which have been dropped and rules which will one day be i
* https://github.com/SonarSource/rspec/tree/master/rules[rules] directory: contains every specified rule.
** `rules/Sxxxx`: contains every specification for rule `Sxxxx`.
*** `rules/Sxxxx/*.adoc`: Asciidoc files which can be reused by multiple language-specific descriptions.
*** `rules/Sxxxx/metadata.json`: rule metadata shared between language-specific RSPECs. Each language can override fields in its own `metadata.json` file.
*** `rules/Sxxxx/metadata.json`: rule metadata shared between language-specific RSPECs. Each language can override fields in its own `metadata.json` file. +
It is thanks to this file that you can add `tags`, `securityStandards` etc... to your rule.
*** `rules/Sxxxx/[LANGUAGE]`: contains the language-specific RSPEC. For every rule, there must be at least one `[LANGUAGE]` subdirectory. +
`[LANGUAGE]` can be any of the following:
include::supported_languages.adoc[]
@ -125,6 +126,10 @@ In the `metadata.json` of the rule you want to deprecate:
NOTE: use a GitHub hot-key `t` in the source view to navigate to an existing rule specification.
==== 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. +
Otherwise, create a pull request to change the status of the rule to "closed".
=== 2. Ask for a review
Every PR that is creating or modifying a rule should be reviewed.
@ -175,7 +180,7 @@ 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). +
Untriaged PRs are the ones without any label. You can easily see all of them with the filter https://github.com/SonarSource/rspec/pulls?q=is%3Aopen+is%3Apr+no%3Alabel[`Label > Unlabeled`]. +
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