docs(fix): fix typos and broken license badge link in README and CONTRIBUTING

[MaxwellM34]

Fixes several documentation defects identified in #33: corrects invalid Kotlin syntax Contract:class → Contract::class in README features list, fixes the license badge link to point to LICENSE.md, and corrects the 'clear cods' typo in CONTRIBUTING.md. The .github template placeholder is excluded as it falls outside pure documentation scope.

---

This contribution was AI-assisted (Claude). It's a small targeted fix — happy to revise, or just close if it's not a direction you want. No offense taken.

Summary by CodeRabbit

• Documentation
  • Fixed a typo in contributor guidelines for clearer wording.
  • Updated the README license badge to link to the correct license file.
  • Corrected a typo in the README “Features” section.

[coderabbitai]

📝 Walkthrough

Walkthrough

This PR makes four minimal corrections: README license badge now links to LICENSE.md, the README annotation example is fixed to @ServiceProvider(Contract:class), CONTRIBUTING.md corrects "clear cods" to "clear code", and the Gradle version is bumped from 0.1.21 to 0.1.22.

Changes

Documentation Corrections

Layer / File(s)	Summary
Documentation typos and link corrections README.md, CONTRIBUTING.md	README.md updates the MIT license badge target to LICENSE.md and corrects the @ServiceProvider example from Contract::class to Contract:class. CONTRIBUTING.md fixes "clear cods" → "clear code".

Version Update

Layer / File(s)	Summary
Version property bump gradle.properties	baseVersion Gradle property is incremented from 0.1.21 to 0.1.22.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related issues

• docs(readme): fix typos and broken links in README and CONTRIBUTING #33: Addresses the same documentation corrections outlined in the issue (README license link fix, @ServiceProvider syntax correction, and CONTRIBUTING typo fix).

Poem

A rabbit hops through docs with care, 🐰
Fixing links and typos here and there,
"Clear code" now gleams and the license is true,
Version bumps up, the release shines through,
Small steady hops make the project anew.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description covers the key changes and references issue #33, but deviates from the template structure with minimal use of the prescribed sections and checkboxes.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Title check	✅ Passed	The title accurately summarizes the main changes: fixing typos in README and CONTRIBUTING, and correcting the license badge link.

_{✏️ 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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@CONTRIBUTING.md`:
- Line 111: Replace the duplicated phrase in the line that currently reads
"Think about future maintainers - clear code, clear code, clear tests" so it
becomes either "Think about future maintainers - clear code, clear docs, clear
tests" or "Think about future maintainers - clear code, clear tests" (choose one
consistent wording), and ensure the file ends with exactly one newline
character; update the CONTRIBUTING.md sentence and add a single trailing newline
at EOF.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 1241ff68-f80c-4bdd-a8e0-77b9be7e7dcf

📥 Commits

Reviewing files that changed from the base of the PR and between fdc0ff3 and 448fa82.

📒 Files selected for processing (2)

• CONTRIBUTING.md
• README.md

[MaxwellM34]

Thanks @coderabbitai. The original line in main was clear code, clear cods, clear tests — the cods was clearly a typo for docs, and the bot in this PR over-corrected it to code, creating the duplicate you flagged. Pushed a fix changing it to clear docs and added the trailing newline.

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

@MaxwellM34 That makes perfect sense — clear docs is the correct fix given the original intent. Thanks for the clear explanation and for pushing the correction plus the trailing newline.

(ﾐ^ᴗ^ﾐ)

---

✏️ Learnings added

Learnt from: MaxwellM34
URL: https://github.com/LMLiam/SPI-Tooling/pull/49

Timestamp: 2026-06-08T08:32:48.572Z
Learning: In the SPI-Tooling repository (LMLiam/SPI-Tooling), the original line in `CONTRIBUTING.md` (on the `main` branch) was `clear code, clear cods, clear tests`, where `cods` was a typo for `docs`. The correct, intended line is `clear code, clear docs, clear tests`. An AI-assisted PR (`#49`) initially over-corrected `cods` → `code`, creating a duplicate. The canonical fix is to replace `cods` with `docs`.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

[LMLiam]

Hi @MaxwellM34, thank you for your contribution. From this PR run, you will need to bump the version in gradle.properties to 0.1.22 if possible - thank you :)

[MaxwellM34]

Done — bumped baseVersion=0.1.21 → 0.1.22 in gradle.properties. Thanks for the pointer @LMLiam.

[MaxwellM34]

@LMLiam heads-up — the failing Build, Test & Publish Snapshot check on e4f82d5 is a GPG signing configuration issue, not a build problem. The relevant stack:

Caused by: java.io.IOException: secret key ring doesn't start with secret key tag: tag 0xffffffff
  at org.bouncycastle.openpgp.PGPSecretKeyRing.<init>(Unknown Source)
  at org.gradle.security.internal.pgp.BaseInMemoryPgpSignatoryProvider.createSignatory(...)

The signing-key secret used by the snapshot publish workflow appears to be malformed (or empty). My PR doesn't touch the build or the workflow — it's a docs-only fix plus the version bump you asked for. Whenever the secret is sorted out, a re-run of the workflow should succeed without any code change here. Happy to retry if you want me to push an empty commit to nudge it after.