Skip to content

Conversation

@sdwheeler
Copy link
Collaborator

@sdwheeler sdwheeler commented Jun 1, 2023

PR Summary

PR #11452 added the -Detailed parameter to provide detailed output for the TcpPortParameterSet. However, the parameter is defined as a member of all parameter sets.

This PR assigns the parameter to the TcpPortParameterSet.

PR Context

PR Checklist

@daxian-dbw
Copy link
Member

@TravisEz13 You reviewed the PR #11452, so can you please take a quick look at this change?

@TravisEz13 TravisEz13 added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Jun 5, 2023
@StevenBucher98 StevenBucher98 added the PowerShell-Docs needed The PR was reviewed and a PowerShell Docs update is needed label Jun 5, 2023
@pull-request-quantifier-deprecated

This PR has 2 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       : +1 -1
Percentile : 0.8%

Total files changed: 1

Change summary by file extension:
.cs : +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.

@daxian-dbw
Copy link
Member

daxian-dbw commented Jun 6, 2023

The Update-Help test failures in the Ubuntu 22.04 container test run are not related to change in this PR.

  Describing Validate Update-Help from the Web for all PowerShell modules.
Remove-Item: /__w/1/s/test/powershell/engine/Help/UpdatableHelpSystem.Tests.ps1:218
Line |
 218 |                  Remove-Item ($moduleHelpPath) -Recurse
     |                  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     | You do not have sufficient access rights to perform this operation or
     | the item is hidden, system, or read only.
Remove-Item: /__w/1/s/test/powershell/engine/Help/UpdatableHelpSystem.Tests.ps1:218
Line |
 218 |                  Remove-Item ($moduleHelpPath) -Recurse
     |                  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     | Directory /__w/1/a/bins/publish/en-US cannot be removed because it is
     | not empty.
Update-Help: /__w/1/s/test/powershell/engine/Help/UpdatableHelpSystem.Tests.ps1:222

@daxian-dbw daxian-dbw merged commit b09ee16 into PowerShell:master Jun 6, 2023
@sdwheeler sdwheeler deleted the sdw-fix-pr11452 branch June 27, 2023 18:44
@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-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Extra Small PowerShell-Docs needed The PR was reviewed and a PowerShell Docs update is needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants