Skip to content
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

Add Milliseconds Parameter to New-TimeSpan #17621

Merged
merged 1 commit into from
Jul 12, 2022

Conversation

NoMoreFood
Copy link
Contributor

@NoMoreFood NoMoreFood commented Jul 3, 2022

PR Summary

This PR adds a parameter to the New-TimeSpan cmdlet and updates the tests associated with the cmdlet to accomadate testing the new parameter.

PR Context

The ability to set millisecond precision in a timespan structure could be beneficial where consumers of a timespan structure have millisecond resolution. This was requested under issue #16486.

PR Checklist

@pull-request-quantifier-deprecated

This PR has 34 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       : +19 -15
Percentile : 13.6%

Total files changed: 2

Change summary by file extension:
.cs : +3 -1
.ps1 : +16 -14

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 detetcted.
  • 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 iSazonov Jul 3, 2022
@NoMoreFood
Copy link
Contributor Author

@PaulHigin It looks like the only failed test asking me to do something that would make the comment for this property inconsistent with the rest of the comments on the other properties. Let me know if you want me to change them all or if we can ignore this check.

@iSazonov iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Jul 7, 2022
@iSazonov
Copy link
Collaborator

iSazonov commented Jul 7, 2022

@NoMoreFood CodeFactor Ci is not mandatory. I am ok to keep consistency with over doc comments.

@iSazonov
Copy link
Collaborator

iSazonov commented Jul 7, 2022

@NoMoreFood Please create new issue in Docs repository and add reference in OP.

@iSazonov iSazonov added the Documentation Needed in this repo Documentation is needed in this repo label Jul 7, 2022
@NoMoreFood
Copy link
Contributor Author

Copy link
Collaborator

@kilasuit kilasuit left a comment

Choose a reason for hiding this comment

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

Looks good to me :-)

@iSazonov iSazonov removed the Documentation Needed in this repo Documentation is needed in this repo label Jul 12, 2022
@iSazonov iSazonov merged commit ca0178a into PowerShell:master Jul 12, 2022
@iSazonov
Copy link
Collaborator

@NoMoreFood Thanks for your contribution!

@NoMoreFood NoMoreFood deleted the timespan branch July 12, 2022 11:10
@ghost
Copy link

ghost commented Jul 18, 2022

🎉v7.3.0-preview.6 has been released which incorporates this pull request.:tada:

Handy links:

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 Small
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants