Skip to content

Conversation

@JamesWTruher
Copy link
Collaborator

@JamesWTruher JamesWTruher commented Sep 15, 2023

PR Summary

PR Context

see https://github.com/orgs/PowerShell/discussions/20214

PR Checklist

@JamesWTruher JamesWTruher changed the title WIP: set experimental features to stable for 7.4 release Set experimental features to stable for 7.4 release Sep 19, 2023
@microsoft-github-policy-service microsoft-github-policy-service bot added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Sep 21, 2023
Co-authored-by: Steve Lee <slee@microsoft.com>
@microsoft-github-policy-service microsoft-github-policy-service bot removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Sep 21, 2023
Copy link
Member

@SteveL-MSFT SteveL-MSFT left a comment

Choose a reason for hiding this comment

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

LGTM

@pull-request-quantifier-deprecated

This PR has 147 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       : +48 -99
Percentile : 49.4%

Total files changed: 9

Change summary by file extension:
.cs : +48 -93
.ps1 : +0 -6

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.

Copy link
Collaborator

@SeeminglyScience SeeminglyScience left a comment

Choose a reason for hiding this comment

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

LGTM!

michaeltlombardi added a commit to michaeltlombardi/PowerShellDocs that referenced this pull request Nov 20, 2023
…` default

Prior to this change, the documentation for the `$PSNativeCommandUseErrorActionPreference`
variable noted that it defaults to `$true` starting in PowerShell 7.4.

The different default value was temporary for gathering feedback while
7.4 was in preview. When 7.4 was released as stable, the default value
was reverted to `$false` in PowerShell/PowerShell#20285.

This change:

- Replaces the misleading sentence with one that states the defaultc
  value as `$true`.
- Fixes MicrosoftDocs#10661
michaeltlombardi added a commit to michaeltlombardi/PowerShellDocs that referenced this pull request Nov 20, 2023
…` default (MicrosoftDocs#10664)

Prior to this change, the documentation for the `$PSNativeCommandUseErrorActionPreference`
variable noted that it defaults to `$true` starting in PowerShell 7.4.

The different default value was temporary for gathering feedback while
7.4 was in preview. When 7.4 was released as stable, the default value
was reverted to `$false` in PowerShell/PowerShell#20285.

This change:

- Replaces the misleading sentence with one that states the defaultc
  value as `$true`.
- Fixes MicrosoftDocs#10661
@daxian-dbw daxian-dbw added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Jan 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

BackPort-7.4.x-Done CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Medium

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants