8000 Replace `UTF8Encoding(false)` with `Encoding.Default` part 2 by xtqqczze · Pull Request #18356 · PowerShell/PowerShell · GitHub
[go: up one dir, main page]
Skip to content

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

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
Nov 7, 2022
Merged

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

merged 2 commits into from
Nov 7, 2022

Conversation

xtqqczze
Copy link
Contributor
@xtqqczze xtqqczze commented Oct 23, 2022 •
edited
Loading

8000
@pull-request-quantifier-deprecated
Copy link

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 reviewed Oct 23, 2022
View reviewed changes
Copy link
Collaborator
@iSazonov iSazonov left a comment

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?

src/System.Management.Automation/utils/ClrFacade.cs
if (s_defaultEncoding == null)
{
// load all available encodings
EncodingRegisterProvider();
Copy link
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
Copy link
Contributor Author
xtqqczze commented Oct 23, 2022 •
edited
Loading

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 c 8000 hange to Encoding.Default, I do not foresee any difficulty updating PowerShell codebase.

cc: @JamesWTruher

@xtqqczze
Copy link
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
Copy link
ghost commented Oct 31, 2022

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 approved these changes Nov 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 1688b0f into PowerShell:master Nov 7, 2022
@ghost ghost removed the Review - Needed The PR is being reviewed label Nov 7, 2022
@unfurl-links unfurl-links bot mentioned this pull request Nov 11, 2022
Closed
5 tasks
@daxian-dbw daxian-dbw mentioned this pull request Nov 17, 2022
Merged
13 tasks
@adityapatwardhan adityapatwardhan added the CL-Engine Indicates that a PR should be marked as an engine change in the Change Log label Dec 20, 2022
This was referenced Mar 19, 2024
Closed
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@iSazonov iSazonov iSazonov left review comments

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

@anmenaga anmenaga Awaiting requested review from anmenaga

@PaulHigin PaulHigin Awaiting requested review from PaulHigin

Assignees

@daxian-dbw daxian-dbw

Labels
CL-Engine Indicates that a PR should be marked as an engine 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
@xtqqczze @daxian-dbw @iSazonov @adityapatwardhan
0