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

Add support for Singleton's in VocabularyAnnotationInaccessibleTarget #2055

Merged
merged 1 commit into from
Apr 20, 2021

Conversation

marabooy
Copy link
Member

@marabooy marabooy commented Apr 19, 2021

Issues

This pull request fixes issue #2054.

Description

Adds support for singletons as targets in VocabularyAnnotationInaccessible target rule.

Checklist (Uncheck if it is not completed)

  • Test cases added
  • Build and test with one-click build and test script passed

@marabooy marabooy changed the title Add support for Singleton's in VocabularyAnnotationInaccessibleTarget… Add support for Singleton's in VocabularyAnnotationInaccessibleTarget Apr 19, 2021
@marabooy marabooy force-pushed the fix-annotation-rule branch from 9725565 to 7059878 Compare April 19, 2021 09:13
@marabooy marabooy requested a review from Sreejithpin April 19, 2021 09:57
@marabooy marabooy force-pushed the fix-annotation-rule branch from 7059878 to 243b29c Compare April 19, 2021 11:59
Copy link
Contributor

@gathogojr gathogojr left a comment

Choose a reason for hiding this comment

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

Good stuff!

… Rule.

And reduce nesting of the if statements.
@marabooy marabooy force-pushed the fix-annotation-rule branch from f2a772c to e476e86 Compare April 20, 2021 05:49
@pull-request-quantifier-deprecated

This PR has 134 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       : +69 -65
Percentile : 46.8%

Total files changed: 3

Change summary by file extension:
.cs : +69 -65

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 detetcted.
  • 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.

@marabooy marabooy merged commit fa696c9 into OData:master Apr 20, 2021
@marabooy marabooy deleted the fix-annotation-rule branch April 20, 2021 16:04
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.

Add support for Singleton's in VocabularyAnnotationInaccessibleTarget Rule.
4 participants