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.

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

Fix codefactor if part 5 #19286

Merged
merged 3 commits into from Mar 16, 2023
Merged

Conversation

CarloToso
Copy link
Contributor

@CarloToso CarloToso commented Mar 7, 2023

PR Summary

Fix codefactor errors with if
around 22 files

PR Context

Contributes to #19266

PR Checklist

@pull-request-quantifier-deprecated

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


Quantification details

Label      : Medium
Size       : +128 -65
Percentile : 58.6%

Total files changed: 21

Change summary by file extension:
.cs : +128 -65

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.

@ghost ghost assigned TravisEz13 Mar 7, 2023
@iSazonov iSazonov added the CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log label Mar 8, 2023
@ghost ghost added the Review - Needed The PR is being reviewed label Mar 15, 2023
@ghost
Copy link

ghost commented Mar 15, 2023

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

@iSazonov
Copy link
Collaborator

@CarloToso Does the PR fix all rest issues? If so please activate analyzer rule.

@ghost ghost removed the Review - Needed The PR is being reviewed label Mar 15, 2023
@CarloToso
Copy link
Contributor Author

@iSazonov There are many more codefactor issues (more than 800) to fix before we can activate the analyzer rule. I think we should wait for dotnet format to work again (probably after the release of dotnet 8 stable)

@iSazonov
Copy link
Collaborator

@iSazonov There are many more codefactor issues (more than 800) to fix before we can activate the analyzer rule. I think we should wait for dotnet format to work again (probably after the release of dotnet 8 stable)

Maybe this work in Visual Studio?

@CarloToso
Copy link
Contributor Author

@iSazonov I think we can merge this. I currently can't test Visual Studio format, can you do it?

@iSazonov iSazonov merged commit 69e9b43 into PowerShell:master Mar 16, 2023
3 checks passed
@iSazonov iSazonov assigned iSazonov and unassigned TravisEz13 Mar 16, 2023
@CarloToso CarloToso deleted the Fix-codefactor-if-part-5 branch March 16, 2023 17:08
@ghost
Copy link

ghost commented Apr 20, 2023

🎉v7.4.0-preview.3 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 Medium
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants