Skip to content

chore: curate OSS presentation — badges, CI, templates, contributing - #15

Merged
yesil merged 1 commit into
mainfrom
chore/oss-presentation
May 16, 2026
Merged

chore: curate OSS presentation — badges, CI, templates, contributing#15
yesil merged 1 commit into
mainfrom
chore/oss-presentation

Conversation

@yesil

@yesil yesil commented May 16, 2026

Copy link
Copy Markdown
Owner

Summary

Curate the project so it reads as mature and trustworthy to a first-time visitor on GitHub and npm, and add the missing community/automation scaffolding.

  • README: shields.io badges (npm version, downloads, minzipped size, zero-deps, license, CI), explicit npm link, new Links + License sections, Contributing now points to CONTRIBUTING.md
  • CI: GitHub Actions workflow (Node 22, npm cinpm testnpm run build) on push to main and all PRs
  • Templates: YAML issue forms (bug/feature), issue config, PR template
  • CONTRIBUTING.md: dev setup, browser-test model, project structure, Conventional Commits
  • examples/index.html: restyled dependency-free demo landing (was a bare list)
  • package.json: sideEffects: false, engines: node >=22, lint script
  • eslint.config.mjs: ignore dist/** and bundled swc.js

Type of change

  • Documentation
  • Other — repo presentation / CI / tooling

Test plan

  • npm test passes (37/37) on Node 22
  • npm run build reproduces committed artifacts (no churn)
  • CI workflow YAML validated with @action-validator/cli
  • GitHub repo About (description, homepage, topics) updated via gh

Reviewer notes

  • Lint is intentionally not a CI gate. The repo is not prettier-clean — there is pre-existing formatting debt in src/router.js, src/makeLitObserver.js, and 3 test files. CI runs tests + build only (both green). npm run lint is available locally; npm run lint -- --fix will clean the debt whenever you want to re-enable a lint gate.
  • The CI badge will show "no status" until the workflow runs for the first time on main after merge.
  • Out of scope (flagged, not changed): exports["./router"] points to ./src/router.js while the main entry uses dist/ — a real packaging inconsistency worth a separate fix.

Co-Authored-By: Claude Opus 4.7 noreply@anthropic.com

Make the project read as mature on GitHub and npm:

- README: shields.io badges (npm version/downloads/size/deps/license/CI),
  npm link, Links + License sections, Contributing points to CONTRIBUTING.md
- CI: GitHub Actions workflow (Node 22, npm ci + test + build) on push/PR
- Templates: YAML issue forms, issue config, PR template
- CONTRIBUTING.md: dev setup, browser-test model, conventions
- examples/index.html: styled dependency-free demo landing
- package.json: sideEffects:false, engines node>=22, lint script
- eslint.config.mjs: ignore dist/ and bundled swc.js

Lint is intentionally not a CI gate: the repo is not prettier-clean
(pre-existing formatting debt in src/test), so CI runs tests + build only.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@yesil
yesil merged commit 50123ba into main May 16, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant