Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Replace UTF8Encoding(false) with Encoding.Default part 2#18356

Merged
daxian-dbw merged 2 commits into
PowerShell:masterPowerShell/PowerShell:masterfrom
xtqqczze:Encoding.Default2xtqqczze/PowerShell-PowerShell:Encoding.Default2Copy head branch name to clipboard
Nov 7, 2022
Merged

Replace UTF8Encoding(false) with Encoding.Default part 2#18356
daxian-dbw merged 2 commits into
PowerShell:masterPowerShell/PowerShell:masterfrom
xtqqczze:Encoding.Default2xtqqczze/PowerShell-PowerShell:Encoding.Default2Copy head branch name to clipboard

Conversation

@xtqqczze

@xtqqczze xtqqczze commented Oct 23, 2022

Copy link
Copy Markdown
Contributor

@pull-request-quantifier-deprecated

Copy link
Copy Markdown

This PR has 42 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       : +17 -25
Percentile : 16.8%

Total files changed: 13

Change summary by file extension:
.cs : +17 -25

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.

@ghost ghost assigned daxian-dbw Oct 23, 2022
@xtqqczze xtqqczze marked this pull request as ready for review October 23, 2022 01:14

@iSazonov iSazonov left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Do we not have concerns that the .Net default will be changed in the future while we don't want such a change?

if (s_defaultEncoding == null)
{
// load all available encodings
EncodingRegisterProvider();

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I don't remember if we have tests for that.

@xtqqczze

xtqqczze commented Oct 23, 2022

Copy link
Copy Markdown
Contributor Author

Do we not have concerns that the .Net default will be changed in the future while we don't want such a change?

Since .NET Core 2.0, Encoding.Default returns UTF-8 without BOM across all platforms. .NET will not make another breaking change like this without good reason.

In the unlikely event of a breaking change to Encoding.Default, I do not foresee any difficulty updating PowerShell codebase.

cc: @JamesWTruher

@xtqqczze

Copy link
Copy Markdown
Contributor Author

@iSazonov You may be interested in the .NET breaking change to proposal to Encoding.UTF8, see dotnet/runtime#51353.

@ghost ghost added the Review - Needed The PR is being reviewed label Oct 31, 2022
@ghost

ghost commented Oct 31, 2022

Copy link
Copy Markdown

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

@daxian-dbw daxian-dbw left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CL-Engine Indicates that a PR should be marked as an engine change in the Change Log Extra Small

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

Morty Proxy This is a proxified and sanitized view of the page, visit original site.