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

♻️ Remove Rehearsal from IActionContext #3485

Conversation

greymistcube
Copy link
Contributor

@greymistcube greymistcube commented Nov 13, 2023

♻️ In preparation for version 4.0.0. DumbAction needs to be refactored further to remove RecordRehearsal property at some point. 🙄

@greymistcube greymistcube changed the base branch from main to 3.8-maintenance November 13, 2023 13:31
@greymistcube greymistcube self-assigned this Nov 13, 2023
@greymistcube greymistcube marked this pull request as ready for review November 13, 2023 13:33
@riemannulus
Copy link
Member

The build seems failed.

@greymistcube
Copy link
Contributor Author

Eh, for whatever reason, builds are being flaky now. Manual retries seem to fix the issues. 🙄

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


Quantification details

Label      : Medium
Size       : +51 -147
Percentile : 59.6%

Total files changed: 18

Change summary by file extension:
.md : +4 -1
.cs : +47 -146

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.

@riemannulus
Copy link
Member

I'm worried that there will be too many API changes... but this PR is nothing to the problem.

@riemannulus
Copy link
Member

Check when you bump to lib9c and more. They have their own IActionContext serializer. (lib9c, headless, unity)

@greymistcube
Copy link
Contributor Author

@riemannulus
Hence I've preemptively worked on removing references to Rehearsal from lib9c as seen here and here to make the transition as smooth as possible.

@greymistcube greymistcube merged commit 06d7357 into planetarium:3.8-maintenance Nov 14, 2023
16 of 18 checks passed
@riemannulus
Copy link
Member

Ah, yes we use ICommitedActionContext when calling render event. I missed. 😆

@greymistcube greymistcube deleted the refactor/remove-rehearsal branch November 15, 2023 09:55
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.

2 participants