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

♻️ Refactor BlockCommit encoding #2938

Conversation

greymistcube
Copy link
Contributor

♻️ An accompanying PR to #2927. 😗

@codecov
Copy link

codecov bot commented Mar 15, 2023

Codecov Report

Merging #2938 (1d18531) into 0.51-maintenance (8f3b269) will decrease coverage by 0.02%.
The diff coverage is 100.00%.

Additional details and impacted files
@@                 Coverage Diff                  @@
##           0.51-maintenance    #2938      +/-   ##
====================================================
- Coverage             80.89%   80.87%   -0.02%     
====================================================
  Files                   335      335              
  Lines                 11757    11761       +4     
====================================================
+ Hits                   9511     9512       +1     
- Misses                 2246     2249       +3     
Impacted Files Coverage Δ
Libplanet/Blocks/BlockCommit.cs 97.67% <100.00%> (+0.23%) ⬆️

... and 5 files with indirect coverage changes

@pull-request-quantifier-deprecated

This PR has 16 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       : +9 -7
Percentile : 6.4%

Total files changed: 3

Change summary by file extension:
.md : +2 -0
.cs : +7 -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.

@greymistcube greymistcube merged commit 48188be into planetarium:0.51-maintenance Mar 15, 2023
7 of 8 checks passed
@greymistcube greymistcube deleted the refactor/blockcommit-encoding branch May 17, 2023 02:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants