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

Added GraphQL type descriptions #2074

Merged
merged 9 commits into from
Jun 16, 2022
Merged

Added GraphQL type descriptions #2074

merged 9 commits into from
Jun 16, 2022

Conversation

Akamig
Copy link
Member

@Akamig Akamig commented Jun 13, 2022

This PR resolves #1247, and "Tried but failed" to mediate #2065, but failed due to Generics of each queries in explorer.
Is there any good Idea to circumvent each IActions required by all queries?

Copy link
Member

@longfin longfin left a comment

Choose a reason for hiding this comment

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

@Akamig Sadly, the build is failing. 😢there are two main reasons.

  1. Lint is complaining "Line must be no longer than 100 characters"
  2. StandaloneSchema needs a type argument T.

@Akamig
Copy link
Member Author

Akamig commented Jun 14, 2022

@longfin
Alright, I changed :

@longfin longfin self-requested a review June 14, 2022 04:39
Copy link
Member

@longfin longfin left a comment

Choose a reason for hiding this comment

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

@Akamig Oops, lint is now complaining that "The parameter spans multiple lines". 😢

I guess it would be better checking dotnet build on your local env before commit & push. 🙏

@Akamig
Copy link
Member Author

Akamig commented Jun 14, 2022

Maybe should I shorten description to fit under 100 characters?
but It may confuse users because of lack of additional description.

@longfin
Copy link
Member

longfin commented Jun 14, 2022

but It may confuse users because of lack of additional description.

It seems that make sense. then, disabling lint using #progma warning (like this) can be solution. cc @planetarium/libplanet

@longfin longfin self-requested a review June 14, 2022 04:53
@Akamig Akamig changed the title Added GraphQL type descriptions and "tried to" define schema. Added GraphQL type descriptions Jun 14, 2022
longfin
longfin previously approved these changes Jun 14, 2022
Libplanet.Explorer/GraphTypes/ActionType.cs Outdated Show resolved Hide resolved
Co-authored-by: Swen Mun <longfinfunnel@gmail.com>
@pull-request-quantifier-deprecated

This PR has 126 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       : +94 -32
Percentile : 45.2%

Total files changed: 3

Change summary by file extension:
.cs : +94 -32

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.

@Akamig Akamig merged commit 6b2ccce into planetarium:main Jun 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
No open projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Explorer: GraphQL type descriptions
4 participants