Docs: Prepare Project for Being Public ✨

[yezz123]

No description provided.

[codecov]

Codecov Report

Merging #102 (d0fe983) into main (0c69b90) will not change coverage.
The diff coverage is n/a.

❗ Current head d0fe983 differs from pull request most recent head ac700ea. Consider uploading reports for the commit ac700ea to get more accurate results

@@           Coverage Diff           @@
##             main     #102   +/-   ##
=======================================
  Coverage   72.03%   72.03%           
=======================================
  Files          34       34           
  Lines        1241     1241           
=======================================
  Hits          894      894           
  Misses        347      347           

---

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 0c69b90...ac700ea. Read the comment docs.

[pull-request-quantifier-deprecated]

This PR has 63 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       : +32 -31
Percentile : 25.2%

Total files changed: 4

Change summary by file extension:
.all-contributorsrc : +0 -11
.md : +19 -18
.yml : +13 -2

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.

[yezz123]

@all-contributors add @yezz123 for code, doc, maintenance, infra

[allcontributors]

@yezz123

I've put up a pull request to add @yezz123! 🎉

[yezz123]

@all-contributors add @AbderrahimSoubaiElidrissi for review, doc

[allcontributors]

@yezz123

I've put up a pull request to add @AbderrahimSoubaiElidrissi! 🎉