Skip to content

docs: fix README and contributing typos #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dejoski wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix README and contributing typos #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to SPI-Tooling

Firstly, thank you for taking the time contribute!
Firstly, thank you for taking the time to contribute!
SPI-Tooling exists to make service loading easier, and your ideas, fixes and improvements help make that possible.

This guide will walk you through how to set up your environment, make changes, and submit them in a way that keeps the project reproducible and contributor-friendly.
Expand Down Expand Up @@ -108,4 +108,4 @@ Releases are automated via GitHub Actions and occur when a push or merge is made
## Tips for Contributors
- Keep changes focused - small, atomic PRs are easier to review
- If you're unsure about an approach, open a Draft PR early for feedback
- Think about future maintainers - clear code, clear cods, clear tests
- Think about future maintainers - clear code, clear docs, clear tests
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![Annotations Maven Central](https://img.shields.io/maven-central/v/io.github.eventhorizonlab/spi-tooling-annotations?color=blue)](https://central.sonatype.com/artifact/io.github.eventhorizonlab/spi-tooling-annotations)
[![Processor Maven Central](https://img.shields.io/maven-central/v/io.github.eventhorizonlab/spi-tooling-processor?color=blue)](https://central.sonatype.com/artifact/io.github.eventhorizonlab/spi-tooling-processor)
[![Build](https://github.com/EventHorizonLab/SPI-Tooling/actions/workflows/release-and-publish.yml/badge.svg)](https://github.com/EventHorizonLab/SPI-Tooling/actions)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE.md)

---
## 📖 Overview
Expand All @@ -18,7 +18,7 @@ This is designed for:

---
## ✨ Features
- **Annotation‑driven**: Mark your contracts with `@ServiceContract` and service implementations with `@ServiceProvider(Contract:class)`
- **Annotation‑driven**: Mark your contracts with `@ServiceContract` and service implementations with `@ServiceProvider(Contract::class)`
- **Automatic `META-INF/services` generation** at compile time.
- **Multi‑module aware**: Handles aggregation across modules without collisions.
- **Deterministic output**: Stable ordering for reproducible builds.
Expand Down Expand Up @@ -181,4 +181,4 @@ Manual SPI file management is:
- Error-prone (typos, missing entries)
- Hard to maintain in multi-module setups
- A barrier for new contributors
`spi-tooling` makes it automatic, safe, and reproducible -- so you can focus on building features, not maintaing service files.
`spi-tooling` makes it automatic, safe, and reproducible -- so you can focus on building features, not maintaining service files.