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

Introduce IActionTypeLoaderContext #2653

Merged
merged 1 commit into from Dec 28, 2022

Conversation

moreal
Copy link
Contributor

@moreal moreal commented Dec 20, 2022

You can see the below content in CHANGES.md too.

Backward-incompatible changes

  • Replaced IPreEvaluationBlockHeader-typed blockHeader parameter with
    IActionTypeLoaderContext-typed context parameter in the below methods.
    • IActionTypeLoader.Load().
    • IActionTypeLoader.LoadAllActionTypes().

Added APIs

  • Added IActionTypeLoaderContext interface.

@moreal moreal self-assigned this Dec 20, 2022
@moreal moreal force-pushed the action-typeloader-context branch 2 times, most recently from 4ea41f2 to dfe52de Compare December 20, 2022 08:25
@moreal moreal requested a review from longfin December 20, 2022 08:39
@moreal moreal marked this pull request as ready for review December 20, 2022 08:39
@moreal moreal requested review from a team, dahlia and limebell and removed request for a team December 27, 2022 01:02
Libplanet/Action/IActionTypeLoaderContext.cs Outdated Show resolved Hide resolved
Libplanet/Action/IActionTypeLoaderContext.cs Outdated Show resolved Hide resolved
Libplanet/Blocks/Block.cs Outdated Show resolved Hide resolved
@pull-request-quantifier-deprecated

This PR has 36 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       : +27 -9
Percentile : 14.4%

Total files changed: 6

Change summary by file extension:
.md : +7 -0
.cs : +20 -9

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.

@moreal
Copy link
Contributor Author

moreal commented Dec 28, 2022

Could you review this pull request one more time? 🙏🏻 @longfin

@moreal moreal merged commit 90e6c0b into planetarium:main Dec 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

2 participants