Skip to content

SONARJAVA-5144 Update Custom rules documentation to match MyJavaFileCheckRegistrarTest#4903

Merged
erwan-serandour merged 2 commits intomasterfrom
erwan/update-custom-rules-tutorial
Oct 14, 2024
Merged

SONARJAVA-5144 Update Custom rules documentation to match MyJavaFileCheckRegistrarTest#4903
erwan-serandour merged 2 commits intomasterfrom
erwan/update-custom-rules-tutorial

Conversation

@erwan-serandour
Copy link
Copy Markdown
Contributor

No description provided.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Feel free to apply the suggestion on the separate lines that form a single sentence.

Comment thread docs/CUSTOM_RULES_101.md Outdated
Comment on lines +569 to +570
To do so, navigate to its corresponding test class, named `MyJavaFileCheckRegistrarTest`, add your rule key to the end of the mainRuleKeys list
and your rule class name at the end of the mainCheckClasses list.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can probably put the whole sentence on single line here. This should help review changes to the text in the future

Suggested change
To do so, navigate to its corresponding test class, named `MyJavaFileCheckRegistrarTest`, add your rule key to the end of the mainRuleKeys list
and your rule class name at the end of the mainCheckClasses list.
To do so, navigate to its corresponding test class, named `MyJavaFileCheckRegistrarTest`, add your rule key to the end of the mainRuleKeys list and your rule class name at the end of the mainCheckClasses list.

@erwan-serandour erwan-serandour force-pushed the erwan/update-custom-rules-tutorial branch from ead0cbf to 6593694 Compare October 14, 2024 13:15
@erwan-serandour erwan-serandour force-pushed the erwan/update-custom-rules-tutorial branch from 6593694 to bcc59dc Compare October 14, 2024 13:34
@sonarqube-next
Copy link
Copy Markdown

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

@erwan-serandour erwan-serandour merged commit 841ea33 into master Oct 14, 2024
@erwan-serandour erwan-serandour deleted the erwan/update-custom-rules-tutorial branch October 14, 2024 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants