Skip to content

Conversation

@daxian-dbw
Copy link
Member

@daxian-dbw daxian-dbw commented Oct 10, 2022

PR Summary

Replace command-error suggestion with new implementation based on subsystem plugin.

  • Make the feedback provider extensible just like the predictor plugin
  • Allow one implementation to serve as multiple subsystems

Two built-in feedback providers are included:

  • GeneralCommandErrorFeedback, serves the same suggestion functionality existing today
  • UnixCommandNotFound, available on Linux, utilize the command-not-found command on Linux platforms, to provide feedback similar as bash does.

The UnixCommandNotFound serves as both a feedback provider and a predictor. The suggestion from command-not-found command is used both for providing the feedback when command cannot be found in an interactive run, and for providing predictive intellisense results for the next command line.

To-do's

  • Fix failing tests
  • Add tests
  • Add experimental feature
  • Separate UnixCommandNotFound out as a module Will move UnixCommandNotFound to UnixCompleter module, but this is not blocking the PR.
  • Open doc issue

This is a screenshot after applying the styles for feedback rendering:

image

PR Context

image

new1

new2

PR Checklist

@ghost ghost assigned TravisEz13 Oct 10, 2022
@daxian-dbw daxian-dbw assigned daxian-dbw and unassigned TravisEz13 Oct 10, 2022
@daxian-dbw daxian-dbw added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Oct 10, 2022
Copy link
Member

@SteveL-MSFT SteveL-MSFT left a comment

Choose a reason for hiding this comment

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

This feature is great, but should be an experimental feature separate from PSCommandNotFoundSuggestion feature.

@ghost ghost added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Oct 11, 2022
@ghost ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Oct 17, 2022
@ghost ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Oct 17, 2022
@daxian-dbw daxian-dbw marked this pull request as ready for review October 17, 2022 21:16
@daxian-dbw daxian-dbw requested a review from anmenaga as a code owner October 17, 2022 21:16
@pull-request-quantifier-deprecated

This PR has 504 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       : +434 -70
Percentile : 83.47%

Total files changed: 17

Change summary by file extension:
.json : +4 -2
.cs : +426 -61
.resx : +4 -7

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.

@daxian-dbw daxian-dbw removed the request for review from anmenaga October 17, 2022 21:23
@daxian-dbw
Copy link
Member Author

@SteveL-MSFT Please take another look when you have time. All to-dos are done (please see the to-do list in the PR description).
I will start adding the command-not-found feedback provider and predictor to UnixCompleter once this PR gets merged.

Copy link
Member

@SteveL-MSFT SteveL-MSFT left a comment

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-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Extra Large

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants