docs: refresh README and contribution guide#21
Conversation
There was a problem hiding this comment.
Pull request overview
Refreshes the project’s public-facing documentation so the README reads like a package homepage (positioning + quick adoption path) while moving contributor workflow details into a dedicated, expanded contribution guide.
Changes:
- Rewrites
README.mdto lead with positioning/value props, a tighter quick start, and a reorganized feature overview. - Updates
CONTRIBUTING.mdwith clearer local setup, validation commands, test DB configuration, and PR expectations.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Reorganized and rewritten to better communicate value proposition, quick start, and key capabilities. |
| CONTRIBUTING.md | Expanded and clarified contributor principles, local setup, check commands, and test DB env configuration. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - MySQL/MariaDB on `127.0.0.1:3306` | ||
| - PostgreSQL on `127.0.0.1:5432` |
There was a problem hiding this comment.
docker-compose.yml exposes ports with "3306:3306" / "5432:5432", which bind to all host interfaces by default (not strictly 127.0.0.1). Consider wording this as “localhost:3306/5432” or “host port 3306/5432” (or update the compose file to explicitly bind 127.0.0.1: if that’s the intent).
| - MySQL/MariaDB on `127.0.0.1:3306` | |
| - PostgreSQL on `127.0.0.1:5432` | |
| - MySQL/MariaDB on host port `3306` | |
| - PostgreSQL on host port `5432` |
Summary
The repository landing page was technically accurate, but it read more like internal reference material than a package homepage. That made the project harder to evaluate quickly for developers looking for a lightweight PDO-first ORM, and it mixed contributor workflow details into the main README instead of giving them a dedicated home.
The root cause was that the README emphasized feature inventory and maintenance notes before clearly selling the value proposition, adoption path, and ideal use case. Contributor guidance already existed, but it needed to stand on its own so the README could stay focused on users deciding whether to adopt the library.
This change rewrites the README to be more promotional while keeping the claims aligned with the existing API. It now leads with a stronger positioning statement, clearer value bullets, a tighter quick-start flow, and a more deliberate feature breakdown. It also narrows the README's closing section into a simple set of follow-on links.
In parallel, the contribution guide was refreshed as the dedicated contributor document. It now clearly covers local setup, validation commands, test database configuration, coding expectations, pull request guidance, and contribution terms without relying on the README for context.
Validation
I ran the existing PHPUnit suite to confirm the documentation-only change did not coincide with any unrelated regressions:
vendor/bin/phpunit -c phpunit.xml.dist