ishangsf/rspec
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
2,472 Commits 329 Branches 2 Tags
Commit Graph

51 Commits

Author SHA1 Message Date
hendrik-buchwald-sonarsource
d3b00511bb
Modify rule S5547: LaYC format (#2023) 2023-06-12 15:58:19 +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
Sebastien Marichal
a549ff28d4 Modify rule S2187: LaYC format (#2042) 2023-06-07 12:01:33 +02:00
Cristian Ambrosini
d18a0f74ab Modify rule S2699: Migrate to new educational format (#1956) 2023-06-07 12:01:33 +02:00
Cristian Ambrosini
82e7c93900 Modify rule S2970: LaYC format (#1985) 2023-06-07 12:01:33 +02: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
Jonas Wielage
98a4f7ad7e
Modify rule S6349: Update for educational format (#1845) 2023-05-11 10:26:42 +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
41bb545c92
metadata.adoc: add link to the Coding rule guidelines on SonarQube (#1641) 2023-03-15 13:13:35 +00: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
gaetan-ferry-sonarsource
ee0a3dc8f0 Modify rule S6384: Change text to the progressive education format (APPSEC-424) (#1535) 2023-03-02 19:03:03 +01:00
Egon Okerman
1f4aed2865 Modify S6105: Move to progressive education format (APPSEC-422) (#1519) 
* Move metadata to root

* Define S6105 for JS/TS

* Move message.adoc

* Fix incorrect autolink

* Fix standards header

* Add "noncompliant" to code sample

* Change header styling

* Apply suggestions from code review

Co-authored-by: gaetan-ferry-sonarsource <112399173+gaetan-ferry-sonarsource@users.noreply.github.com>

* Update rules/S6105/common/fix/how-does-this-work.adoc

Co-authored-by: gaetan-ferry-sonarsource <112399173+gaetan-ferry-sonarsource@users.noreply.github.com>

* Update rules/S6105/common/pitfalls/starts-with.adoc

Co-authored-by: gaetan-ferry-sonarsource <112399173+gaetan-ferry-sonarsource@users.noreply.github.com>

* Remove reference to javascript pseudo-protocol

* Update rules/S6105/common/fix/how-does-this-work.adoc

Co-authored-by: gaetan-ferry-sonarsource <112399173+gaetan-ferry-sonarsource@users.noreply.github.com>

* Rewrite startsWith text

* Change framework name

Co-authored-by: gaetan-ferry-sonarsource <112399173+gaetan-ferry-sonarsource@users.noreply.github.com>
 2023-03-02 19:03:03 +01:00
gaetan-ferry-sonarsource
3481cef5d1 Modify rule S6398: Switch text to progressive education format (APPSEC-426) (#1507) 2023-03-02 19:03:03 +01:00
Loris S
8a800594ae Modify S3649(JS): Add Education Framework (#1500) 2023-03-02 19:03:03 +01:00
pedro-oliveira-sonarsource
7a277cf1b4 Modify rule S2078: Change text to the education framework format [Python][APPSEC-269] (#1393) 2023-03-02 19:03:03 +01:00
pedro-oliveira-sonarsource
0ba8e669ea Modify rule S5147: Change text to the education framework format [Python][APPSEC-232] (#1389) 2023-03-02 19:03:03 +01:00
Pierre-Loup
79996e1a83 Modify rule S5144[PHP]: Change text to the education framework format (APPSEC-286) (#1424) 2023-03-02 19:03:03 +01:00
pedro-oliveira-sonarsource
e2224a008d [APPSEC-290] Modify rule S2631 (JavaScript): Change text to the education framework format (#1419) 2023-03-02 19:03:03 +01:00
Pierre-Loup
afce946dbd Modify rule S5144[Python]: Change text to the education framework format (APPSEC-285) (#1401) 2023-03-02 19:03:03 +01:00
Egon Okerman
f22ae4c3e2 [APPSEC-271] Modify rule S2091: Change text to the education framework format [Python] (#1396) 
* Add rule information

* Add lxml

* Add Python stdlib

* Change the XPath queries such that they're correct

* Remove nonexistant highlighting reference

* Add lxml as allowed framework

* Split up parameterized queries and validation

* Fix typo

* Make changes in Java docs

* Fix .NET text

* Update rules/S2091/python/how-to-fix-it/python.adoc

Co-authored-by: Pierre-Loup <49131563+pierre-loup-tristant-sonarsource@users.noreply.github.com>

* Update common texts

* Update code samples

* Fix typo

* Use correct syntax for lxml

* Apply code review fixes

Co-authored-by: Pierre-Loup <49131563+pierre-loup-tristant-sonarsource@users.noreply.github.com>
 2023-03-02 19:03:03 +01:00
pedro-oliveira-sonarsource
042a03691e Modify rule S2078: Change text to the education framework format [Python][APPSEC-269] (#1393) 2023-03-02 18:48:41 +01:00
pedro-oliveira-sonarsource
a95e5405ad Modify rule S5147: Change text to the education framework format [Python][APPSEC-232] (#1389) 2023-03-02 18:48:41 +01:00
Pierre-Loup
98874d53a2 Modify rule S5147[JS/TS]: Change text to the education framework format (APPSEC-233) (#1384) 2023-03-02 18:48:41 +01:00
gaetan-ferry-sonarsource
c8d2a90efb Modify rule S5135: Change text to the education framework format [PHP][APPSEC-230] (#1373) 2023-03-02 18:48:41 +01:00
gaetan-ferry-sonarsource
ad240854e1 Modify rule S5135: Change text to the education framework format [Python][APPSEC-228] (#1365) 2023-03-02 18:48:41 +01:00
gaetan-ferry-sonarsource
b64c10e0bf Modify rule S2076: Change text to education framework structure (Py,JS,PHP) [APPSEC-186] (#1359) 2023-03-02 18:22:24 +01:00
Loris S
02af23c1b3 Modify S3649(multiple languages): Update to the education framework (APPSEC-184) (#1336) 2023-03-02 18:22:24 +01:00
Loris S
f8e412528e Modify S2083(multiple languages): Update to the education framework (APPSEC-188) (#1328) 2023-03-02 18:22:24 +01:00
Loris S
cec8459153 Modify S5147(multiple languages): Update to the education framework (APPSEC-89) (#1192) 2023-03-02 18:22:24 +01:00
hendrik-buchwald-sonarsource
c7c5f04b1d [APPSEC-67] Modify rule S5334: Educational content (#1176) 2023-03-02 18:07:54 +01:00
pedro-oliveira-sonarsource
67b3e1ce20 [APPSEC-56] Modify rule S2076: Educational content (Java) (#1150) 2023-03-02 18:07:54 +01:00
Pierre-Loup
511dd0d576 Modify Rule S5883(Java): Education Framework (APPSEC-62) (#1147) 2023-03-02 18:07:54 +01:00
Loris S
770ad9756d Modify Rule S3649: Education Framework (APPSEC-46 & APPSEC-47) (#1109) 2023-03-02 18:07:54 +01:00
Pierre-Loup
dbca6ec12c Modify rule S2083[C#]: Educational content (APPSEC-49) (#1121) 2023-03-02 18:07:54 +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
Roberto Orlandi
dc83422098 SONARSEC-3040 Update checks and documentation to fit new rule format (#1004) 2023-03-02 18:07:54 +01:00
Ilia Kebets
4cdfa1ab5d
AsciiDoc Dos & Don'ts 2023-02-28 10:34:49 +00:00
hendrik-buchwald-sonarsource
4d44fc3fac
Adjust literals in styling guide to SC Design System (#947) 2022-04-12 08:57:59 +00:00
Marco Antognini
a1d49e7e84
Reference the styling guide 
Bring more visibility to the styling guidelines.
 2022-04-05 14:48:04 +02:00
hendrik-buchwald-sonarsource
2cbeca92bc
Add styling guide to docs (#930) 2022-04-05 12:13:17 +02:00
Marco Antognini
dbb8027666 RULEAPI-748: Add new workflow to update quickfix status 2022-02-28 12:08:21 +01:00
Fred Tingaud
b4161466e6
RULEAPI-661: Add syntax coloring 2022-02-04 16:28:24 +00:00
Arseniy Zaostrovnykh
571a66341a
Fix a file name 2022-02-01 16:06:24 +00:00
Fred Tingaud
7d868d3f35
Use a more readable form to display parameters 2022-02-01 12:25:23 +00:00
Marco Antognini
c3a07c83a5
RULEAPI-635: Document testing process 2022-01-13 10:27:30 +00:00