8000 Make experimental feature `PSCleanBlock` stable by SteveL-MSFT · Pull Request #18043 · PowerShell/PowerShell · GitHub
[go: up one dir, main page]
Skip to content

Make experimental feature PSCleanBlock stable #18043

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Sep 7, 2022
Merged

Make experimental feature PSCleanBlock stable #18043

merged 2 commits into from
Sep 7, 2022

Conversation

SteveL-MSFT
Copy link
Member
@SteveL-MSFT SteveL-MSFT commented Sep 6, 2022 •
edited
Loading

PR Summary

PS-Committee reviewed this and decided that this is an opt-in feature that's been available for awhile and commit to fixing bugs should they come up thus making it stable.

PR Context

Per #17962 making this stable

PR Checklist

@ghost ghost assigned iSazonov Sep 6, 2022
@pull-request-quantifier-deprecated
Copy link

This PR has 17 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       : +2 -15
Percentile : 6.8%

Total files changed: 5

Change summary by file extension:
.json : +0 -2
.cs : +2 -13

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
daxian-dbw approved these changes Sep 7, 2022
View reviewed changes
Copy link
Member
@daxian-dbw daxian-dbw left a comment

Choose a reason for hiding this comment

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

LGTM

@daxian-dbw daxian-dbw merged commit 6e36446 into PowerShell:master Sep 7, 2022
@daxian-dbw daxian-dbw assigned daxian-dbw and unassigned iSazonov Sep 7, 2022
@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 Sep 7, 2022
@SteveL-MSFT SteveL-MSFT deleted the PSCleanBlock branch September 7, 2022 21:36
@adityapatwardhan
Copy link
Member

/backport to release/v7.3.0-rc.1

@github-actions github-actions bot mentioned this pull request Sep 12, 2022
Merged
1 task
@ghost
Copy link
ghost commented Sep 20, 2022

🎉v7.3.0-preview.8 has been released which incorporates this pull request.:tada:

Handy links:

@michaeltlombardi michaeltlombardi mentioned this pull request Sep 21, 2022
Closed
2 tasks
@TravisEz13 TravisEz13 mentioned this pull request Sep 30, 2022
Merged
22 tasks
@ghost
Copy link
ghost commented Dec 20, 2022

🎉v7.4.0-preview.1 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
Reviewers

@daxian-dbw daxian-dbw daxian-dbw approved these changes

@iSazonov iSazonov iSazonov approved these changes

Assignees

@daxian-dbw daxian-dbw

Labels
Backport-7.3.x-Done CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Extra Small
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@SteveL-MSFT @adityapatwardhan @daxian-dbw @iSazonov
0