Skip to content

Commit 8cf11cf

Browse files
committed
docs(readme): lead with what it is, where it fits and how to upgrade
Moves the development notes and the how-it-works paragraph to CONTRIBUTING.md so the README covers install, quickstart, reference, Interchange wiring and the 0.1 upgrade path. Every tsx block typechecks against the packed build.
1 parent 5d0a253 commit 8cf11cf

2 files changed

Lines changed: 229 additions & 223 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@ registry and developed with [bun](https://bun.sh) as its package manager and tas
55
Read [ARCHITECTURE.md](./ARCHITECTURE.md) first — most of the rules below only make sense
66
once that is clear.
77

8+
## How it works
9+
10+
Components never fetch; data arrives as props. The root entry is generated re-exports
11+
only, and the package is side-effect free apart from its CSS, so either import style
12+
tree-shakes. Tokens and keyframes live in `theme.css`; `styles.css` is the prebuilt sheet
13+
for hosts that do not run Tailwind. [PRODUCT.md](./PRODUCT.md) covers why the library
14+
exists and [IMPLEMENTATION.md](./IMPLEMENTATION.md) the toolchain and peers.
15+
816
## Getting set up
917

1018
```sh
@@ -184,3 +192,10 @@ Check your item in both modes and at 200% zoom before opening a change.
184192
- Run the gates locally and say so in the pull request: `dep-guard`, `typecheck`, `lint`,
185193
and `build` including the contrast gate. Nothing runs them for you yet.
186194
- Contributions are accepted under the repository's LGPL-2.1-only licence.
195+
196+
## Commit messages
197+
198+
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.
199+
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 `!`.
200+
Keep subjects imperative, lowercase after the colon, 72 characters or less, and free of ticket IDs.
201+
Every PR links its Linear ticket with a `Closes CL-xxxx` line in the PR body.

0 commit comments

Comments
 (0)