Skip to content

Conversation

@spaette
Copy link
Contributor

@spaette spaette commented Jan 30, 2023

This fixes primarily double slash XML C# comments.

Pay special attention to whether the changes to the following files are acceptable.

src/System.Management.Automation/engine/parser/Compiler.cs
src/System.Management.Automation/engine/runtime/Binding/Binders.cs
src/System.Management.Automation/security/CatalogHelper.cs
src/System.Management.Automation/engine/ComInterop/IDispatchComObject.cs
src/Microsoft.Management.UI.Internal/HelpWindow/ParagraphBuilder.cs

Copy link
Collaborator

@iSazonov iSazonov left a comment

Choose a reason for hiding this comment

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

LGTM with one comment.

@iSazonov iSazonov closed this Feb 3, 2023
@iSazonov iSazonov reopened this Feb 3, 2023
@pull-request-quantifier-deprecated

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


Quantification details

Label      : Extra Small
Size       : +24 -24
Percentile : 19.2%

Total files changed: 63

Change summary by file extension:
.wxs : +1 -1
.cs : +21 -21
.resx : +1 -1
.txt : +1 -1

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.

@iSazonov
Copy link
Collaborator

iSazonov commented Feb 3, 2023

Reopen to restart CIs.

@iSazonov iSazonov assigned iSazonov and unassigned anmenaga Feb 3, 2023
@iSazonov iSazonov added the CL-Docs Indicates that a PR should be marked as a documentation change in the Change Log label Feb 3, 2023
@iSazonov iSazonov changed the title fix typos Fix typos in comments Feb 3, 2023
@iSazonov iSazonov merged commit ec0eb22 into PowerShell:master Feb 3, 2023
@iSazonov
Copy link
Collaborator

iSazonov commented Feb 3, 2023

@spaette Thanks for your contribution!

@spaette
Copy link
Contributor Author

spaette commented Feb 3, 2023

to be precise these typo corrected strings weren't found in comments

AmbiguosAuthentication
IsHomogenousArray
sucessfulDecompression

and there were some typo fixes of strings which had appeared enclosed in double quotes

also hopefully some textual changes for the purpose of readability

@ghost
Copy link

ghost commented Mar 14, 2023

🎉v7.4.0-preview.2 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-Docs Indicates that a PR should be marked as a documentation change in the Change Log Extra Small

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants