Polish README and add CONTRIBUTING for public GitHub

2026-08-05 14:47:18 -04:00
parent 0d703bfed7
commit 7cb1c50baa
2 changed files with 31 additions and 2 deletions
@@ -0,0 +1,25 @@
+# Contributing
+
+Thanks for looking at **playkit**.
+
+## How this repo is published
+
+- **Public mirror:** [github.com/Gitilia/playkit](https://github.com/Gitilia/playkit)
+- **Development + CI:** private forge (Gitea). npm publishes to a private registry used by Levkin apps.
+
+## Issues
+
+GitHub **issues** are welcome for bugs, API ideas, and docs gaps.
+
+## Pull requests
+
+Small docs/test fixes via GitHub PR are fine. For larger API changes, open an issue first so we can align — the mirror may lag the forge, and merge gates run on the forge.
+
+## Local setup
+
+```bash
+npm install
+npm test
+```
+
+See the README for consumer install (`@levkin/playkit`) and fixture examples.