odata.net
odata.net copied to clipboard
extremely minor perf updates
While writing instance annotations, we only write annotations if they don't start with odata. or if they do start with odata. but they aren't in a list of known annotation names. These checks are conceptually correct, but the logic as written requires checking the annotation name for odata. more than once. While updating the code to remove this logic, I wrote a test to validate that instance annotations of different kind were still written/not written accordingly. While doing this, I discovered that the ODataInstanceAnnotation type validates that the name isn't an OData instance annotation in the first place. Because of this, there is no reason to validate the annotation name at all while writing the annotations, so I've removed that unnecessary logic.
The ODataInstanceAnnotation type also validates that the name is well-formed by checking if it contains a . character to ensure that a namespace is present. It further confirms that the . does not come at the beginning or the end of the name. The code as written would check for the presence of a . and then would check if the first or last character was a .. However, if the first or last character is a ., there's no need to do the initial check. I have changed the order of these predicates so that the string is not enumerated unless all of the other conditions are met first.
This PR has 10 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 : +7 -3
Percentile : 4%
Total files changed: 3
Change summary by file extension:
.cs : +7 -3
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
Excludedsection from yourprquantifier.yamlcontext profile. - Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your
prquantifier.yamlcontext profile. - Only use the labels that matter to you, see context specification to customize your
prquantifier.yamlcontext 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).
- For PRs that fall outside of the desired spectrum, review the details and check if:
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? :thumbsup: :ok_hand: :thumbsdown: (Email) Customize PullRequestQuantifier for this repository.