chore: curate OSS presentation — badges, CI, templates, contributing - #15
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.
CONTRIBUTING.mdnpm ci→npm test→npm run build) on push tomainand all PRssideEffects: false,engines: node >=22,lintscriptdist/**and bundledswc.jsType of change
Test plan
npm testpasses (37/37) on Node 22npm run buildreproduces committed artifacts (no churn)ghReviewer notes
src/router.js,src/makeLitObserver.js, and 3 test files. CI runs tests + build only (both green).npm run lintis available locally;npm run lint -- --fixwill clean the debt whenever you want to re-enable a lint gate.mainafter merge.exports["./router"]points to./src/router.jswhile the main entry usesdist/— a real packaging inconsistency worth a separate fix.Co-Authored-By: Claude Opus 4.7 noreply@anthropic.com