Skip to content

docs: fix README and contributing typos - #51

Draft
YforC wants to merge 1 commit into
LMLiam:mainfrom
YforC:docs-fix-readme-contributing-typos
Draft

docs: fix README and contributing typos#51
YforC wants to merge 1 commit into
LMLiam:mainfrom
YforC:docs-fix-readme-contributing-typos

Conversation

@YforC

@YforC YforC commented Jun 9, 2026

Copy link
Copy Markdown

Summary

Fix small documentation and issue-template mistakes reported in #33.

Related Issues / Tickets

Changes in Detail

  • Fix the README license badge link to point to LICENSE.md.
  • Correct the Kotlin @ServiceProvider(MyContract::class) example.
  • Fix spelling in README.md and CONTRIBUTING.md.
  • Remove the unrelated Paper server placeholder from the bug report template.

Modules Affected

  • spi-tooling-annotations
  • spi-tooling-processor
  • Other: documentation and issue template

Versioning

  • Version bump applied (release PR)
  • Snapshot only (PR build)

Testing

  • Steps:
    1. Ran rg for the old typo/link/template strings.
    2. Confirmed no old strings remain.

Checklist

  • Code builds locally without errors
  • All tests pass locally (./gradlew kotest)
  • Added/updated tests for new or changed logic
  • Updated documentation / README if needed
  • No unrelated changes included

Notes for Reviewers

This is a docs/template-only cleanup, so no Gradle test run was needed.

@coderabbitai

coderabbitai Bot commented Jun 9, 2026

Copy link
Copy Markdown

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 2aa6c050-6d4b-41c4-a3c0-6d7408f764a3

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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

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