Skip to content

WIP: Enable CA1822 for types with internal visibility #15838

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
Closed
xtqqczze wants to merge 12 commits into from
Closed

WIP: Enable CA1822 for types with internal visibility #15838

xtqqczze wants to merge 12 commits into from

Conversation

@xtqqczze
Copy link
Contributor

@xtqqczze xtqqczze commented Jul 28, 2021

Non-breaking change as fixes are only for types with an effective visibility of internal.

https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1822

Follow-up to: #13897.

@xtqqczze
Copy link
Contributor Author

xtqqczze commented Jul 29, 2021 •
edited
Loading

PowerShell-CI-windows Failing after 4m — Build #PR-15838-20210728.02 failed:

D:\a\1\s\src\Microsoft.PowerShell.Commands.Diagnostics\PdhHelper.cs(1019,21): error CA1822: Member 'LookupPerfNameByIndex' does not access instance data and can be marked as static [D:\a\1\s\src\Microsoft.PowerShell.Commands.Diagnostics\Microsoft.PowerShell.Commands.Diagnostics.csproj]
D:\a\1\s\src\Microsoft.PowerShell.Commands.Diagnostics\PdhHelper.cs(1136,23): error CA1822: Member 'GetCounterSetHelp' does not access instance data and can be marked as static [D:\a\1\s\src\Microsoft.PowerShell.Commands.Diagnostics\Microsoft.PowerShell.Commands.Diagnostics.csproj]

I thought src\Microsoft.PowerShell.Commands.Diagnostics\PdhHelper.cs was not compiled (#14491 (comment)), yet we have a code quality diagnostic being reported?

It seems diagnostics are still running at build time for PdhHelper.

@iSazonov
Copy link
Collaborator

iSazonov commented Jul 29, 2021 •
edited
Loading

I thought src\Microsoft.PowerShell.Commands.Diagnostics\PdhHelper.cs was not compiled (#14491 (comment)), yet we have a code quality diagnostic being reported?

No, please exclude non-compliling code and frozen code too.

Also 68 files are too many for review. Please split the PR on some parts.

@xtqqczze
Copy link
Contributor Author

xtqqczze commented Jul 29, 2021

I thought src\Microsoft.PowerShell.Commands.Diagnostics\PdhHelper.cs was not compiled (#14491 (comment)), yet we have a code quality diagnostic being reported?

No, please exclude non-compliling code and frozen code too.

Also 68 files are too many for review. Please split the PR on some parts.

PdhHelper.cs is compiled, but only on Windows:

PowerShell/src/Microsoft.PowerShell.Commands.Diagnostics/Microsoft.PowerShell.Commands.Diagnostics.csproj

Lines 24 to 28 in 0f2f23f

<ItemGroup Condition=" '$(IsWindows)' != 'true' ">
<Compile Remove="GetCounterCommand.cs" />
<Compile Remove="CounterSample.cs" />
<Compile Remove="CounterSet.cs" />
<Compile Remove="PdhHelper.cs" />

@xtqqczze xtqqczze marked this pull request as draft July 29, 2021 16:17
@ghost ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Aug 1, 2021
@ghost ghost added the Stale label Aug 16, 2021
@ghost
Copy link

ghost commented Aug 16, 2021

This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 15 days. It will be closed if no further activity occurs within 10 days of this comment.

@xtqqczze xtqqczze closed this Aug 23, 2021
@xtqqczze xtqqczze reopened this Aug 23, 2021
@ghost ghost removed the Stale label Aug 23, 2021
@ghost ghost added the Stale label Sep 7, 2021
@ghost
Copy link

ghost commented Sep 7, 2021

This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 15 days. It will be closed if no further activity occurs within 10 days of this comment.

@ghost ghost closed this Sep 18, 2021
@iSazonov iSazonov reopened this Sep 18, 2021
@ghost ghost closed this Sep 28, 2021
@daxian-dbw daxian-dbw reopened this Sep 28, 2021
@daxian-dbw daxian-dbw removed Stale Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Sep 28, 2021
@ghost ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Oct 2, 2021
@ghost ghost added the Stale label Nov 3, 2021
@ghost
Copy link

ghost commented Nov 3, 2021

This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 15 days. It will be closed if no further activity occurs within 10 days of this comment.

@ghost ghost closed this Nov 22, 2021
@iSazonov iSazonov reopened this Nov 24, 2021
@pull-request-quantifier-deprecated
Copy link

pull-request-quantifier-deprecated bot commented Nov 24, 2021

This PR has 553 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details 

Label      : Extra Large
Size       : +289 -264
Percentile : 85.1%

Total files changed: 72

Change summary by file extension:
.globalconfig : +1 -1
.cs : +288 -263

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detetcted.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.

Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

@ghost ghost removed the Stale label Nov 24, 2021
@ghost ghost added the Stale label Dec 9, 2021
@ghost
Copy link

ghost commented Dec 9, 2021

This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 15 days. It will be closed if no further activity occurs within 10 days of this comment.

@ghost ghost closed this Dec 20, 2021
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@adityapatwardhan adityapatwardhan Awaiting requested review from adityapatwardhan adityapatwardhan is a code owner

@anmenaga anmenaga Awaiting requested review from anmenaga

@daxian-dbw daxian-dbw Awaiting requested review from daxian-dbw daxian-dbw is a code owner

@TravisEz13 TravisEz13 Awaiting requested review from TravisEz13 TravisEz13 will be requested when the pull request is marked ready for review TravisEz13 is a code owner

@SeeminglyScience SeeminglyScience Awaiting requested review from SeeminglyScience SeeminglyScience will be requested when the pull request is marked ready for review SeeminglyScience is a code owner

Assignees

@adityapatwardhan adityapatwardhan

Labels

Extra Large Stale Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@xtqqczze @iSazonov @daxian-dbw @adityapatwardhan