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

support reading relative context urls with bulk updates #2618

Conversation

ElizabethOkerio
Copy link
Contributor

@ElizabethOkerio ElizabethOkerio commented Feb 17, 2023

Issues

This PR adds support for reading payloads with relative context URLs. Currently we support @context with absolute URLS:
EXA of a payload with a relative context URL that will be supported by these changes:

{
    "@context": "#$delta",
    "value": [
        {
            "displayName": "Big cat",
            "percentageWeight": 100
        }
    ]
}
{
    "@context": "Products",
    "value": [
        {
            "displayName": "Big cat",
            "percentageWeight": 100
        }
    ]
}
{
    "@context": "$metadata#Products",
    "value": [
        {
            "displayName": "Big cat",
            "percentageWeight": 100
        }
    ]
}

Description

Briefly describe the changes of this pull request.

Checklist (Uncheck if it is not completed)

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

Additional work necessary

If documentation update is needed, please add "Docs Needed" label to the issue and provide details about the required document change in the issue.

@ElizabethOkerio ElizabethOkerio changed the title support reading relative context urls with support reading relative context urls with bulk updates Feb 17, 2023
@ElizabethOkerio ElizabethOkerio force-pushed the feature/support_relative_context_urls branch from d414fdc to c6de720 Compare February 21, 2023 08:21
@ElizabethOkerio ElizabethOkerio marked this pull request as ready for review February 21, 2023 08:21
@ElizabethOkerio ElizabethOkerio assigned habbes and unassigned habbes Feb 21, 2023
xuzhg
xuzhg previously approved these changes Feb 23, 2023
@ElizabethOkerio ElizabethOkerio force-pushed the feature/support_relative_context_urls branch from 49df4ff to 5119bca Compare February 27, 2023 15:20
@pull-request-quantifier-deprecated

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


Quantification details

Label      : Small
Size       : +67 -18
Percentile : 34%

Total files changed: 6

Change summary by file extension:
.cs : +67 -18

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.

@ElizabethOkerio ElizabethOkerio merged commit 335eef0 into OData:master Feb 28, 2023
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.

5 participants