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 More Classifiers & Fix Typo ✨ #3

Merged
merged 3 commits into from
Oct 10, 2021
Merged

Add More Classifiers & Fix Typo ✨ #3

merged 3 commits into from
Oct 10, 2021

Conversation

yezz123
Copy link
Owner

@yezz123 yezz123 commented Oct 10, 2021

No description provided.

@yezz123 yezz123 added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 10, 2021
@yezz123 yezz123 self-assigned this Oct 10, 2021
@pull-request-quantifier-deprecated

This PR has 43 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       : +30 -13
Percentile : 17.2%

Total files changed: 7

Change summary by file extension:
.yml : +4 -0
.md : +4 -2
.cfg : +1 -1
.py : +21 -10

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.

@sourcery-ai
Copy link

sourcery-ai bot commented Oct 10, 2021

Sourcery Code Quality Report

❌  Merging this PR will decrease code quality in the affected files by 0.13%.

Quality metrics Before After Change
Complexity 0.41 ⭐ 0.41 ⭐ 0.00
Method Length 34.53 ⭐ 35.13 ⭐ 0.60 👎
Working memory 5.15 ⭐ 5.21 ⭐ 0.06 👎
Quality 87.65% 87.52% -0.13% 👎
Other metrics Before After Change
Lines 158 169 11
Changed files Quality Before Quality After Quality Change
setup.py 66.56% 🙂 64.06% 🙂 -2.50% 👎
fastapi_class/init.py 99.17% ⭐ 99.17% ⭐ 0.00%
fastapi_class/routable.py 79.17% ⭐ 79.17% ⭐ 0.00%
tests/test_routable.py 90.56% ⭐ 90.56% ⭐ 0.00%

Here are some functions in these files that still need a tune-up:

File Function Complexity Length Working Memory Quality Recommendation
fastapi_class/routable.py RoutableMeta.__new__ 4 ⭐ 47 ⭐ 10 😞 72.99% 🙂 Extract out complex expressions

Legend and Explanation

The emojis denote the absolute quality of the code:

  • ⭐ excellent
  • 🙂 good
  • 😞 poor
  • ⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.


Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!

@codecov
Copy link

codecov bot commented Oct 10, 2021

Codecov Report

Merging #3 (eac74a9) into main (87807fe) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main       #3   +/-   ##
=======================================
  Coverage   94.25%   94.25%           
=======================================
  Files           4        4           
  Lines          87       87           
=======================================
  Hits           82       82           
  Misses          5        5           
Impacted Files Coverage Δ
fastapi_class/__init__.py 100.00% <100.00%> (ø)
fastapi_class/routable.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 87807fe...eac74a9. Read the comment docs.

@yezz123 yezz123 merged commit fb59eba into main Oct 10, 2021
@yezz123 yezz123 deleted the Fix-Setup branch October 10, 2021 00:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request Extra Small
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant