Skip to content

docs: fix README and contributing typos - #53

Open
dejoski wants to merge 1 commit into
LMLiam:mainfrom
dejoski:docs/issue-33-readme-cleanup
Open

docs: fix README and contributing typos#53
dejoski wants to merge 1 commit into
LMLiam:mainfrom
dejoski:docs/issue-33-readme-cleanup

Conversation

@dejoski

@dejoski dejoski commented Jun 25, 2026

Copy link
Copy Markdown

Summary

  • fix the README license badge target
  • correct the ServiceProvider attribute example
  • clean up small README and CONTRIBUTING typos

Closes #33

Validation

  • git diff --check

Summary by CodeRabbit

  • Documentation
    • Improved contributor guidance wording and fixed a typo in the contribution tips.
    • Corrected the license badge link in the README.
    • Fixed a Kotlin example snippet and several minor wording/spelling issues in the project overview.

Signed-off-by: Dejan Stajic <8886210+dejoski@users.noreply.github.com>
@coderabbitai

coderabbitai Bot commented Jun 25, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 7b2a9442-fffd-4c5e-ba77-dc850d25b25f

📥 Commits

Reviewing files that changed from the base of the PR and between fdc0ff3 and 28512af.

📒 Files selected for processing (2)
  • CONTRIBUTING.md
  • README.md

📝 Walkthrough

Walkthrough

Updated README and CONTRIBUTING documentation text, including a license badge target, a Kotlin snippet, and several typo fixes.

Changes

Documentation polish

Layer / File(s) Summary
Copy and link fixes
README.md, CONTRIBUTING.md
Updated the README license badge target, corrected a Kotlin annotation example, fixed two README typos, and corrected two CONTRIBUTING typos.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 I hopped through docs with whiskers bright,
and nudged the links to point just right.
::class now sparkles, typos flee,
the README and guide feel snappy to me.
Thump-thump! 🌿

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 warnings)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description covers the main changes and issue number, but it omits several required template sections and detailed testing/context. Add the missing template sections: Changes in Detail, Modules Affected, Versioning, Testing steps, Checklist, and Notes for Reviewers.
Linked Issues check ⚠️ Warning The README and CONTRIBUTING fixes match #33, but the required bug template placeholder update is missing from the changes. Update .github/ISSUE_TEMPLATE/bug_report.yml to use a project-relevant environment placeholder such as JDK, Gradle, and Kotlin versions.
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately reflects the documentation-focused changes, though it omits the badge and code example fixes.
Out of Scope Changes check ✅ Passed The changed files stay within the documentation fixes requested by the issue and show no unrelated additions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(readme): fix typos and broken links in README and CONTRIBUTING

1 participant