Update FAQ so users can easily beautify their PowerShell by Dynesshely · Pull Request #18739 · PowerShell/PowerShell

Dynesshely · 2022-12-07T05:47:08Z

PR Summary

Update FAQ so users can easily beautify their PowerShell

PR Context

I always suggest my friends to use PowerShell, then they tried with complain that why their pwsh are not as beautiful as mine, so I added this and next time I can send them only a link.

PR Checklist

SteveL-MSFT · 2022-12-07T16:42:33Z

I don't think this is a FAQ (which is more targeted for users of this repo), perhaps we can mention oh-my-posh in https://github.com/PowerShell/PowerShell/tree/master/docs/learning-powershell instead?

GitHub
PowerShell/docs/learning-powershell at master · PowerShell/PowerShell
PowerShell for every system! Contribute to PowerShell/PowerShell development by creating an account on GitHub.

Dynesshely · 2022-12-07T16:44:50Z

I don't think this is a FAQ (which is more targeted for users of this repo), perhaps we can mention oh-my-posh in https://github.com/PowerShell/PowerShell/tree/master/docs/learning-powershell instead?

GitHub**PowerShell/docs/learning-powershell at master · PowerShell/PowerShell**PowerShell for every system! Contribute to PowerShell/PowerShell development by creating an account on GitHub.

That's good, I'll move it to https://github.com/PowerShell/PowerShell/tree/master/docs/learning-powershell

GitHub
PowerShell/docs/learning-powershell at master · PowerShell/PowerShell
PowerShell for every system! Contribute to PowerShell/PowerShell development by creating an account on GitHub.

pull-request-quantifier-deprecated · 2022-12-07T16:50:58Z

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

Total files changed: 1

Change summary by file extension:
.md : +5 -0

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.

pull-request-quantifier-deprecated · 2022-12-07T16:50:58Z

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

Total files changed: 1

Change summary by file extension:
.md : +5 -0

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.

iSazonov · 2022-12-07T17:02:37Z

I guess JanDeDobbeleer should be added to exclusions to pass CI.

sdwheeler · 2022-12-07T21:01:51Z

+### Make PowerShell Beautiful
+
+You can use [oh-my-posh](https://ohmyposh.dev/) and see
+its source code in [JanDeDobbeleer/oh-my-posh](https://github.com/JanDeDobbeleer/oh-my-posh).
+
+An Example:
+
+![image](https://user-images.githubusercontent.com/50760269/206097676-58283ed0-d244-4c5c-813d-1218f8bed27f.png)
+


Nothing against oh-my-posh (I use posh-git instead) but does this really belong here in this document. What other 3rd-party tools would want to be listed here?

Also, we already have docs about customizing the shell experience.

Nothing against oh-my-posh (I use posh-git instead) but does this really belong here in this document. What other 3rd-party tools would want to be listed here?

Also, we already have docs about customizing the shell experience.

Yeah it feels a little odd to single out oh-my-posh here when there are quite a few projects in the same area (https://github.com/Jaykul/PowerLine, https://github.com/dahlbyk/posh-git, https://github.com/starship/starship).

If the goal is to have a link to send to folks, I'd recommend writing up a markdown gist with your settings and links to projects

Also, we already have docs about customizing the shell experience.

Has the doc any links to third-party tools?

Nothing against oh-my-posh (I use posh-git instead) but does this really belong here in this document. What other 3rd-party tools would want to be listed here?

Also, we already have docs about customizing the shell experience.

You're right. And where are the docs about customizing the shell experience? Tnx.

sdwheeler · 2022-12-08T13:35:32Z

https://learn.microsoft.com/en-us/powershell/scripting/learn/shell/optimize-shell?view=powershell-7.3

Optimizing your shell experience - PowerShell
This article provides an overview of the shell features that help users improve their user experience.

Dynesshely · 2022-12-08T14:48:32Z

So it doesn't look like the changes really helped much, close.

Dynesshely added 2 commits December 7, 2022 13:42

Update FAQ.md so users can beautify their pwsh easily

f6d75b4

Fix typo in FAQ.md

7c28a41

pull-request-quantifier-deprecated Bot added the Extra Small label Dec 7, 2022

ghost assigned iSazonov Dec 7, 2022

iSazonov requested review from SteveL-MSFT and StevenBucher98 December 7, 2022 05:52

Dynesshely closed this Dec 7, 2022

Dynesshely added 2 commits December 8, 2022 00:48

Move tip of style related into /docs/learning-powershell/

01569aa

Update learning-powershell about how to prettify

c8dfde1

Dynesshely reopened this Dec 7, 2022

StevenBucher98 requested a review from sdwheeler December 7, 2022 17:35

sdwheeler reviewed Dec 7, 2022

View reviewed changes

Dynesshely closed this Dec 8, 2022

Conversation

Dynesshely commented Dec 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Context

PR Checklist

Uh oh!

SteveL-MSFT commented Dec 7, 2022 • edited by unfurl-links Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Dynesshely commented Dec 7, 2022 • edited by unfurl-links Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pull-request-quantifier-deprecated Bot commented Dec 7, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

pull-request-quantifier-deprecated Bot commented Dec 7, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

iSazonov commented Dec 7, 2022

Uh oh!

sdwheeler Dec 7, 2022

Choose a reason for hiding this comment

Uh oh!

SeeminglyScience Dec 7, 2022

Choose a reason for hiding this comment

Uh oh!

iSazonov Dec 8, 2022

Choose a reason for hiding this comment

Uh oh!

Dynesshely Dec 8, 2022

Choose a reason for hiding this comment

Uh oh!

sdwheeler commented Dec 8, 2022 • edited by unfurl-links Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Dynesshely commented Dec 8, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Dynesshely commented Dec 7, 2022 •

edited

Loading

SteveL-MSFT commented Dec 7, 2022 •

edited by unfurl-links Bot

Loading

Dynesshely commented Dec 7, 2022 •

edited by unfurl-links Bot

Loading

sdwheeler commented Dec 8, 2022 •

edited by unfurl-links Bot

Loading