30 Commits

Author SHA1 Message Date
Fred Tingaud
dc89dd499c
Create a shared_content folder at root 2023-07-20 12:17:32 +02:00
Fred Tingaud
51369b610e
Make sure that includes are always surrounded by empty lines (#2270)
When an include is not surrounded by empty lines, its content is inlined
on the same line as the adjacent content. That can lead to broken tags
and other display issues.
This PR fixes all such includes and introduces a validation step that
forbids introducing the same problem again.
2023-06-22 10:38:01 +02:00
hendrik-buchwald-sonarsource
a315e5de4c
Add review checklist
This PR adds a small checklist for new PRs that will make it more
visible what parts of the RSPEC were reviewed.
2023-06-06 17:04:39 +02:00
Roberto Orlandi
dc83422098 SONARSEC-3040 Update checks and documentation to fit new rule format (#1004) 2023-03-02 18:07:54 +01:00
Martin Strecker
6888916f35
Readme: Clarify rule deprecation (#1446) 2022-12-02 17:26:55 +01:00
Fred Tingaud
7d868d3f35
Use a more readable form to display parameters 2022-02-01 12:25:23 +00:00
Marco Antognini
065322db2f
RULEAPI-680: Remove the mention of [label] (#705) 2022-01-13 16:03:40 +00:00
Marco Antognini
c3a07c83a5
RULEAPI-635: Document testing process 2022-01-13 10:27:30 +00:00
Loïc Joly
0553b63456
Make it more explicit what a covered or a partial quickfix means 2021-10-13 15:23:02 +02:00
Arseniy Zaostrovnykh
54ca95619a
Fix the quickfixes section formatting (#463) 2021-10-07 10:02:31 +00:00
Arseniy Zaostrovnykh
6a0ec99e78
RULEAPI-706: Add quick fixes metadata 2021-10-07 09:23:15 +00:00
Arseniy Zaostrovnykh
4d6347f458
RULEAPI-701: Remove stray step (#443) 2021-10-01 14:42:07 +02:00
Arseniy Zaostrovnykh
065138d536
RULEAPI-701: document the use of the new "Add language to a rule" GH action (#438) 2021-10-01 12:30:35 +02:00
Arseniy Zaostrovnykh
090a5c725d
RULEAPI-696: adapt the rspec/readme.adoc narrative to not mention "coveredLanguages" and to menation -branch in rule-api (#408) 2021-09-29 16:04:43 +02:00
Arseniy Zaostrovnykh
cf4373c8e8
RULEAPI-660: Add an exception to the new-rule workflow (#133) 2021-06-16 13:59:09 +00:00
Arseniy Zaostrovnykh
3b55166cad
RULEAPI-654: clarify word "ready" in the workflow 2021-06-14 09:59:42 +02:00
eric-therond-sonarsource
520573b838
RULEAPI-654: Clarify the rule creation process (#115) 2021-06-11 05:58:58 +00:00
Amélie Renard
b042d4cc78
RULEAPI-641 Document how comments can be added to rules (#114) 2021-06-09 14:14:26 +02:00
Amélie Renard
debc5071c3
RULEAPI-623: Update README 2021-06-09 08:35:31 +02:00
Amélie Renard
4f1d739cba
README: Explain labels (#100) 2021-06-07 16:45:47 +02:00
Amélie Renard
c31c51e655
RULEAPI-621 Rename commands "gh_generate" and "gh_update" to "generate" and "update" 2021-06-04 09:27:32 +02:00
Amélie Renard
fbd14d0f8b
RULEAPI-620 Update README 2021-06-02 10:58:42 +02:00
Arseniy Zaostrovnykh
80d3da511c
RULEAPI-583 Add a link from the frontend to Github PRs adding rules 2021-05-05 14:50:29 +02:00
Amélie Renard
19d237ce18
RULEAPI-605 Find the best order in "merge implementation"/"merge specification" and fix rule-api to support it 2021-05-05 14:07:34 +02:00
Amélie Renard
68900c9066
RULEAPI-602 Describe the procedure of deprecating a rule 2021-05-05 09:44:23 +02:00
Amélie Renard
a3a9dd10a7
RULEAPI-598 Provide a way to name a language subdirectory correctly (when specializing a rule) 2021-05-03 21:31:58 +02:00
Amélie Renard
a9c3e3b9c4
RULEAPI-599: Make sure the rule-modification PR title keywords are correctly capitalized 2021-04-29 11:36:26 +02:00
Arseniy Zaostrovnykh
0d4a864a58
Address the feedback from user studies in wording of the readme. 2021-04-28 12:01:25 +02:00
Arseniy Zaostrovnykh
0481d4ff7d
Add the flow-charts and remarks to the documentation. (#43) 2021-02-19 16:54:29 +01:00
Nicolas Harraudeau
d7b1e84f48 Update main README 2021-02-19 09:55:20 +01:00