Skip to content

Conversation

michaeltlombardi
Copy link
Collaborator

PR Summary

Prior to this change, the install instructions for TSToy pointed to a fictional URL. This change:

  1. Moves the tstoy source from the app folder to tstoy, so that using go install pulls the application with the correct name. There is no way to set a canonical name for the executable when installed this way except by folder name.
  2. Updates the build script for the package action to build and archive the application for every supported OS and add them to the tstoy/latest folder. This is a temporary work around until we can get a more canonical solution for "releasing" the fictional app on Github.
  3. Updates the install instructions to enable users to select either option.
  4. Makes minor improvements to the display for the TSToy about page.

PR Checklist

  • Descriptive Title: This PR's title is a synopsis of the changes it proposes.
  • Summary: This PR's summary describes the scope and intent of the change.
  • Contributor's Guide: I have read the contributors guide.
  • Style: This PR adheres to the style guide.

Prior to this change, the install instructions for TSToy pointed to
a fictional URL. This change:

1. Moves the tstoy source from the `app` folder to `tstoy`, so that using
   `go install` pulls the application with the correct name. There is no
   way to set a canonical name for the executable when installed this way
   except by folder name.
1. Updates the build script for the `package` action to build and archive
   the application for every supported OS and add them to the `tstoy/latest`
   folder. This is a temporary work around until we can get a more canonical
   solution for "releasing" the fictional app on Github.
1. Updates the install instructions to enable users to select either option.
1. Makes minor improvements to the display for the TSToy about page.
@michaeltlombardi michaeltlombardi force-pushed the maint/main/fix-tstoy-install branch from a19d188 to 51cf2c5 Compare August 29, 2023 20:29
@sdwheeler sdwheeler merged commit bd62fd0 into PowerShell:main Aug 29, 2023
@pull-request-quantifier-deprecated

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


Quantification details

Label      : Medium
Size       : +94 -23
Percentile : 43.4%

Total files changed: 13

Change summary by file extension:
.gitattributes : +4 -2
.scss : +5 -0
.md : +40 -7
.work : +1 -1
.toml : +1 -1
.yaml : +3 -3
.ps1 : +27 -4
.go : +4 -4
.mod : +1 -1
.txt : +8 -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.

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants