Skip to content

Conversation

@TravisEz13
Copy link
Member

@TravisEz13 TravisEz13 commented Nov 8, 2021

PR Summary

Update change log for 7.2.0

PR Context

This was committed after the tag for 7.2 so it needs to be backported to the 7.2.1 branch.

PR Checklist

Update change log for 7.2.0

# Conflicts:
#	.spelling
@TravisEz13 TravisEz13 merged commit a10da5a into PowerShell:master Nov 8, 2021
@TravisEz13 TravisEz13 deleted the changelog-7-2 branch November 8, 2021 23:03
@pull-request-quantifier-deprecated

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


Quantification details

Label      : Extra Large
Size       : +852 -817
Percentile : 100%

Total files changed: 3

Change summary by file extension:
.spelling : +9 -1
.md : +843 -816

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 detetcted.
  • 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.

@mi-hol
Copy link

mi-hol commented Nov 9, 2021

@TravisEz13 @adityapatwardhan the changelog is by far too thin as it leaves out all the changes made in preview releases but they are important!

@iSazonov
Copy link
Collaborator

iSazonov commented Nov 9, 2021

@mi-hol The change log is incremental. So you should look all parts from 7.1 release to 7.2 release.

@TravisEz13
Copy link
Member Author

Said another way, the entire 7.2.md should be considered the change log for the entire 7.2 release. The last part is only the difference between rc.1 and the final release.

@anmenaga anmenaga added CL-Docs Indicates that a PR should be marked as a documentation change in the Change Log Backport-7.2.x-Done labels Dec 8, 2021
@ghost
Copy link

ghost commented Dec 16, 2021

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

Handy links:

TrapGodBrim pushed a commit to TrapGodBrim/PowerShell that referenced this pull request Jan 19, 2022
* Merged PR 17994: Update change log for 7.2.0

Update change log for 7.2.0

# Conflicts:
#	.spelling

* add blank change log for 7.3

Co-authored-by: Aditya Patwardhan <adityap@microsoft.com>
daxian-dbw pushed a commit to daxian-dbw/PowerShell that referenced this pull request Mar 9, 2022
* Merged PR 17994: Update change log for 7.2.0

Update change log for 7.2.0

# Conflicts:
#	.spelling

* add blank change log for 7.3

Co-authored-by: Aditya Patwardhan <adityap@microsoft.com>
@TravisEz13 TravisEz13 mentioned this pull request Jun 7, 2022
22 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Backport-7.2.x-Done CL-Docs Indicates that a PR should be marked as a documentation change in the Change Log Extra Large

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants