Skip to content

chore(docs): Improve Documentation - #209

Merged
yezz123 merged 1 commit into
mainfrom
Docs/improve
Jan 16, 2022
Merged

yezz123 merged 1 commit into
mainfrom
Docs/improve

Conversation

@yezz123

@yezz123 yezz123 commented Jan 16, 2022

Copy link
Copy Markdown
Owner

No description provided.

@yezz123 yezz123 added the documentation Improvements or additions to documentation label Jan 16, 2022
@yezz123 yezz123 self-assigned this Jan 16, 2022
@pull-request-quantifier-deprecated

Copy link
Copy Markdown

This PR has 40 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       : +21 -19
Percentile : 16%

Total files changed: 4

Change summary by file extension:
.md : +21 -19

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.

@codecov

codecov Bot commented Jan 16, 2022 •

Copy link
Copy Markdown

Codecov Report

Merging #209 (617e8a2) into main (8f7f804) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #209   +/-   ##
=======================================
  Coverage   93.59%   93.59%           
=======================================
  Files          41       41           
  Lines        1452     1452           
=======================================
  Hits         1359     1359           
  Misses         93       93           

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 8f7f804...617e8a2. Read the comment docs.

@yezz123
yezz123 merged commit 419f6f1 into main Jan 16, 2022
@yezz123
yezz123 deleted the Docs/improve branch January 16, 2022 14:26
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 Extra Small

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant