diff --git a/README.adoc b/README.adoc index 8a0d9b165a..353e58b834 100644 --- a/README.adoc +++ b/README.adoc @@ -22,12 +22,12 @@ It is thanks to this file that you can add `tags`, `securityStandards` etc... to **** `rules/Sxxxx/common/resources` *** `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: -* https://github.com/SonarSource/rspec/tree/master/shared_content[shared_content] directory: contains content that needs to be shared among multiple rules. Subfolders are currently not standardized. include::supported_languages.adoc[] **** `rules/Sxxxx/[LANGUAGE]/rule.adoc`: asciidoc file used to generate the `Sxxxx` rule description for programming language `[LANGUAGE]`. It can include parts from `*.adoc` files located in the parent directory. **** `rules/Sxxxx/[LANGUAGE]/metadata.json`: metadatas for the specific language. Each key at the top will completely override the key of the `metadata.json` file of the parent directory. +* https://github.com/SonarSource/rspec/tree/master/shared_content[shared_content] directory: contains content that needs to be shared among multiple rules. Subfolders are currently not standardized. == Rule description file