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

ignore changes to test files in PR Quantifier #2505

Open
wants to merge 2 commits into
base: release-7.x
Choose a base branch
from

Conversation

mikepizzo
Copy link
Member

@mikepizzo mikepizzo commented Sep 6, 2022

Description

The PR Quantifier currently complains about PRs over 200 lines of code, but with test changes even minor PRs exceed that boundary.

Adding a prquantifier.yaml file to limit the quantifier to look at code in the source directory.

Additional work necessary

If this works on this repo, we should add similar logic to the other repos as well.

The PR Quantifier currently complains about PRs over 200 lines of code, but with test changes even minor PRs exceed that boundary.

Adding a prquantifier.yaml file to limit the quantifier to look at code in the source directory.
Set medium limit to 200
@pull-request-quantifier-deprecated

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


Quantification details

Label      : No Changes
Size       : +0 -0
Percentile : 0%

Total files changed: 0

Change summary by file extension:

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.

IgnoreComments: true
IgnoreCodeBlockSeparator: true
DynamicBehaviour: false
IgnoreRenamed: true
Copy link
Contributor

Choose a reason for hiding this comment

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

Renaming files in c# usually results in renaming classes, which although only tedious, I think we might want to reflect in the PR size

Suggested change
IgnoreRenamed: true
IgnoreRenamed: false

IgnoreCodeBlockSeparator: true
DynamicBehaviour: false
IgnoreRenamed: true
IgnoreCopied: true
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not exactly sure what this means, but if someone copy/pastes something and then only changes 5% of it, the whole thing needs to be confirmed for correctness, so we probably want to include this in the size as well

Suggested change
IgnoreCopied: true
IgnoreCopied: false

DynamicBehaviour: false
IgnoreRenamed: true
IgnoreCopied: true
AdditionPercentile:
Copy link
Contributor

Choose a reason for hiding this comment

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

What do these figures represent?

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.

4 participants