Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create rule S6673: Log message template placeholders should be in the right order #2563

Merged
merged 14 commits into from
Mar 14, 2024
Merged

Create rule S6673: Log message template placeholders should be in the right order #2563

merged 14 commits into from
Mar 14, 2024

Conversation

github-actions[bot]
Copy link
Contributor

@github-actions github-actions bot commented Jul 20, 2023 •
edited by martin-strecker-sonarsource
Loading

You can preview this rule here (updated a few minutes after each push).

Trello card

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

@martin-strecker-sonarsource martin-strecker-sonarsource changed the title Create rule S6673 Create rule S6673: Log message template placeholders should be in the right order Jul 20, 2023
antonioaversa
antonioaversa requested changes Jul 21, 2023
View reviewed changes
Copy link
Contributor

@antonioaversa antonioaversa left a comment

Choose a reason for hiding this comment

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

Proposed some restructuring and some rewording, for better clarity.

rules/S6673/csharp/rule.adoc Outdated Show resolved Hide resolved
rules/S6673/csharp/rule.adoc Outdated Show resolved Hide resolved
rules/S6673/csharp/rule.adoc Outdated Show resolved Hide resolved
rules/S6673/csharp/rule.adoc Outdated Show resolved Hide resolved
rules/S6673/metadata.json Show resolved Hide resolved
rules/S6673/csharp/rule.adoc Outdated Show resolved Hide resolved
rules/S6673/csharp/rule.adoc Outdated Show resolved Hide resolved
rules/S6673/csharp/rule.adoc Outdated Show resolved Hide resolved
rules/S6673/csharp/rule.adoc Outdated Show resolved Hide resolved
antonioaversa
antonioaversa reviewed Jul 21, 2023
View reviewed changes
rules/S6673/csharp/rule.adoc Outdated Show resolved Hide resolved
rules/S6673/csharp/rule.adoc Outdated Show resolved Hide resolved
antonioaversa
antonioaversa requested changes Jul 21, 2023
View reviewed changes
Copy link
Contributor

@antonioaversa antonioaversa left a comment

Choose a reason for hiding this comment

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

The C# version looks good to me.
I left a couple of minor comments.
Requesting changing to add the VB.NET part.

antonioaversa
antonioaversa requested changes Jul 25, 2023
View reviewed changes
Copy link
Contributor

@antonioaversa antonioaversa left a comment

Choose a reason for hiding this comment

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

Some minor issues with file naming and structure, and diff-ids.

In this scenario, I would have probably tried writing code valid for both C# and VB.NET (not using named argument, semicolon, and moving comments to normal text before the examples), to avoid all these example_n_compliant/noncompliant.adoc files.

But that's a personal choice, and I find very accurate and structured your approach.

rules/S6673/csharp/example_3_compliant.adoc Outdated Show resolved Hide resolved
rules/S6673/csharp/example_3_noncompliant.adoc Outdated Show resolved Hide resolved
rules/S6673/csharp/rule.adoc Show resolved Hide resolved
rules/S6673/vbnet/example_3_compliant.adoc Outdated Show resolved Hide resolved
rules/S6673/vbnet/example_3_noncompliant.adoc Outdated Show resolved Hide resolved
rules/S6673/vbnet/rule.adoc Outdated Show resolved Hide resolved
@sonarqube-next
Copy link

SonarQube Quality Gate for 'rspec-tools'

Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@sonarqube-next
Copy link

SonarQube Quality Gate for 'rspec-frontend'

Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

antonioaversa
antonioaversa approved these changes Jul 25, 2023
View reviewed changes
Copy link
Contributor

@antonioaversa antonioaversa left a comment

Choose a reason for hiding this comment

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

LGTM!

@martin-strecker-sonarsource martin-strecker-sonarsource mentioned this pull request Jul 25, 2023
Closed
@costin-zaharia-sonarsource costin-zaharia-sonarsource mentioned this pull request Feb 16, 2024
Closed
@sonarqube-next SonarQube-Next
Copy link

sonarqube-next bot commented Mar 5, 2024

Quality Gate passed Quality Gate passed for 'rspec-tools'

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

@sonarqube-next SonarQube-Next
Copy link

sonarqube-next bot commented Mar 5, 2024

Quality Gate passed Quality Gate passed for 'rspec-frontend'

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

@costin-zaharia-sonarsource costin-zaharia-sonarsource marked this pull request as ready for review March 14, 2024 16:44
@costin-zaharia-sonarsource costin-zaharia-sonarsource merged commit 5ca970e into master Mar 14, 2024
11 checks passed
@costin-zaharia-sonarsource costin-zaharia-sonarsource deleted the rule/add-RSPEC-S6673 branch March 14, 2024 16:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@martin-strecker-sonarsource martin-strecker-sonarsource martin-strecker-sonarsource left review comments

@antonioaversa antonioaversa antonioaversa approved these changes

Assignees

@martin-strecker-sonarsource martin-strecker-sonarsource

Labels
dotnet
Projects
None yet
Milestone
No milestone
4 participants
@antonioaversa @martin-strecker-sonarsource @costin-zaharia-sonarsource @zsolt-kolbay-sonarsource