Skip to content

Conversation

Molkree
Copy link
Contributor

@Molkree Molkree commented May 21, 2023

PR Summary

Fix IDE0019 in Microsoft.Management folder.

PR Context

#18399
https://docs.microsoft.com/dotnet/fundamentals/code-analysis/style-rules/ide0019
Microsoft.CodeAnalysis.CSharp version 4.6.0-1.final.
There might have been some manual fixes in this PR but they all fall into 3 categories:

  1. Newly created double newlines that trigger other diagnostics.
  2. Code that previously looked like this
    if (condition)
    {
        Type type = var as Type;
        if (type != null)
        ...
    was fixed to this:
    if (condition)
    {
        if (var is Type type)
        ...
    and I have additionally changed it to this:
    if (condition && var is Type type)
    {
        ...
  3. Once or twice autofix "ate" comments but it might have been in another PR. You can see all similar PRs in the linked issue.

PR Checklist

@pull-request-quantifier-deprecated

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


Quantification details

Label      : Small
Size       : +20 -40
Percentile : 24%

Total files changed: 9

Change summary by file extension:
.cs : +20 -40

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 detected.
  • 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.

@StevenBucher98 StevenBucher98 added the PowerShell-Docs not needed The PR was reviewed and doesn't appear to require a PowerShell Docs update label May 22, 2023
@iSazonov iSazonov added the CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log label May 23, 2023
@iSazonov iSazonov merged commit 1c55e02 into PowerShell:master May 24, 2023
@Molkree Molkree deleted the ide0019-microsoft-management branch May 27, 2023 20:54
@ghost
Copy link

ghost commented Jun 29, 2023

🎉v7.4.0-preview.4 has been released which incorporates this pull request.:tada:

Handy links:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log PowerShell-Docs not needed The PR was reviewed and doesn't appear to require a PowerShell Docs update Small
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants