Skip to content

docs(readme): lead with what it is, where it fits and how to upgrade #72

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

Merged
TheGreatAxios merged 1 commit into from
Sep 27, 2026
Merged

docs(readme): lead with what it is, where it fits and how to upgrade #72

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
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@ registry and developed with [bun](https://bun.sh) as its package manager and tas
Read [ARCHITECTURE.md](./ARCHITECTURE.md) first — most of the rules below only make sense
once that is clear.

## How it works

Components never fetch; data arrives as props. The root entry is generated re-exports
only, and the package is side-effect free apart from its CSS, so either import style
tree-shakes. Tokens and keyframes live in `theme.css`; `styles.css` is the prebuilt sheet
for hosts that do not run Tailwind. [PRODUCT.md](./PRODUCT.md) covers why the library
exists and [IMPLEMENTATION.md](./IMPLEMENTATION.md) the toolchain and peers.

## Getting set up

```sh
Expand Down Expand Up @@ -184,3 +192,10 @@ Check your item in both modes and at 200% zoom before opening a change.
- Run the gates locally and say so in the pull request: `dep-guard`, `typecheck`, `lint`,
and `build` including the contrast gate. Nothing runs them for you yet.
- Contributions are accepted under the repository's LGPL-2.1-only licence.

## Commit messages

Commit subjects and PR titles follow [Conventional Commits](https://www.conventionalcommits.org): `feat`, `fix`, `refactor`, `test`, `docs`, `build`, `ci`, `perf`, and `chore(release): x.y.z` for releases.
Add `!` only for public API breaks: removed or renamed exports, changed signatures, newly required params. Peer and dependency range changes are `build(deps):` with no `!`.
Keep subjects imperative, lowercase after the colon, 72 characters or less, and free of ticket IDs.
Every PR links its issue with a `Closes <issue id>` line in the PR body.
Loading
Loading