18 Commits

Author SHA1 Message Date
John-Clifton-SonarSource
7015855f79
Add additional LayC guidance in docs (#3193)
Adding in additional material and a bit of refactoring for clarity.

## Review

A dedicated reviewer checked the rule description successfully for:

- [ ] logical errors and incorrect information
- [ ] information gaps and missing content
- [ ] text style and tone
- [ ] PR summary and labels follow [the
guidelines](https://github.com/SonarSource/rspec/#to-modify-an-existing-rule)

---------

Co-authored-by: Loris S. <91723853+loris-s-sonarsource@users.noreply.github.com>
2023-10-04 11:19:33 +01:00
Fred Tingaud
dc89dd499c
Create a shared_content folder at root 2023-07-20 12:17:32 +02:00
Amélie Renard
b724d1f7c4
RULEAPI-791 LaYC: add "External coding guidelines" subtitle in the "Resources" section (#2454) 2023-07-13 18:18:01 +02:00
Marco Borgeaud
3caf52608d
Cross reference guides and cosmetics improvements (#2432)
Indent sections in the rule description guide to improve readability.
Cross-reference the link standard in the rule description guide.

## Review

A dedicated reviewer checked the rule description successfully for:

- [x] logical errors and incorrect information
- [x] information gaps and missing content
- [x] text style and tone
- [x] PR summary and labels follow [the
guidelines](https://github.com/SonarSource/rspec/#to-modify-an-existing-rule)
2023-07-11 08:18:38 +01:00
Amélie Renard
ee50358ea1
Update LaYC "More info" section with "Related rules" subtitle 2023-07-03 15:10:21 +02:00
John-Clifton-SonarSource
603acc3d7b
Create tone_guide.adoc (#2088)
Created a tone guide to help rules authors make their content as
compelling for their users as possible.

## Review

A dedicated reviewer checked the rule description successfully for:

- [x] logical errors and incorrect information
- [x] information gaps and missing content
- [x] text style and tone
2023-06-07 12:32:04 +01:00
Christophe Zürn
fb4ba0d61d
Update README and validation to reflect new guidelines (#1951)
Co-authored-by: Elena Vilchik <elena.vilchik@sonarsource.com>
2023-05-30 11:00:48 +02:00
Christophe Zurn
62f01f07fe Update documentation, disallow standard rule format, add allowed sections in 'Why is it an issue?' 2023-05-05 16:29:04 +02:00
Christophe Zürn
0195cdabdd Update docs/description.adoc
Co-authored-by: Victor <106590915+victor-diez-sonarsource@users.noreply.github.com>
2023-05-05 16:29:04 +02:00
Christophe Zurn
daea3fea27 RULEAPI-785 RSPEC: education format "How to fix it" section should be optional 2023-05-05 16:29:04 +02:00
Costin Zaharia
5352da5b03
Add Benchmarks as a supported section on Resources (#1812) 2023-04-27 10:07:31 +02:00
Martin Strecker
bd9bcae0a9
Update description.adoc (#1642) 2023-03-15 13:34:47 +01:00
Christophe Zürn
62a99b38c5
Update education rule description documentation with more details (#1610) 2023-03-08 14:27:59 +01:00
Ilia Kebets
c80d7f3b4c
Add checks for education format (#1607) 2023-03-07 17:16:47 +01:00
Christophe Zürn
47ba59f3b5 RULEAPI-766 Add documentation and integrity checks for new education rule descriptions format (#1098) 2023-03-02 18:07:54 +01:00
Marco Antognini
a1d49e7e84
Reference the styling guide
Bring more visibility to the styling guidelines.
2022-04-05 14:48:04 +02:00
Fred Tingaud
b4161466e6
RULEAPI-661: Add syntax coloring 2022-02-04 16:28:24 +00:00
Fred Tingaud
7d868d3f35
Use a more readable form to display parameters 2022-02-01 12:25:23 +00:00