Skip to content

Option 2 - Change parameter type of -PropertyType to RegistryValueKind for New-ItemProperty #21118

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.

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

Conversation

ArmaanMcleod
Copy link
Contributor

PR Summary

Fixes #21116

This PR contains the code changes required for Option 2 described in linked issue.

Changed parameter type of -PropertyType to RegistryValueKind for New-ItemProperty command.

PR Context

This type change enables tab completion automatically on this parameter, instead having to create an argument completer, like in Option 1 implementation #21117.

PR Checklist

@ArmaanMcleod ArmaanMcleod changed the title Option 1 - Change parameter type of -PropertyType to RegistryValueKind for New-ItemProperty Option 2 - Change parameter type of -PropertyType to RegistryValueKind for New-ItemProperty Jan 20, 2024
@ArmaanMcleod
Copy link
Contributor Author

Wondering if we can optimize this by passing in RegistryValueKind directly instead of converting to string beforehand, since the provider tries to convert from string to RegistryValueKind, which is not needed anymore.

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


Quantification details

Label      : Small
Size       : +45 -25
Percentile : 28%

Total files changed: 7

Change summary by file extension:
.cs : +26 -25
.ps1 : +19 -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.

@ArmaanMcleod
Copy link
Contributor Author

Closing in favour of #21117. Added reason in linked issue, happy to reopen this if we have a change of direction and don't want to use argument completer approach 🙂 .

Copy link
Contributor

microsoft-github-policy-service bot commented Jan 21, 2024

📣 Hey @ArmaanMcleod, how did we do? We would love to hear your feedback with the link below! 🗣️

🔗 https://aka.ms/PSRepoFeedback

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.

New-ItemProperty -PropertyType should have tab completion
2 participants