Repository navigation
docs: add contribution guide - #322
Merged
Merged
Conversation
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.
What
Adds
CONTRIBUTING.md, the how-to document requested in #284 ("The project misses a simple how-to document explaining how to contribute and work with the source code"). It covers:engines),npm install, andnpm run test:setup(Firefox/WebKit via Playwright) plus a local Chrome for the headless Chrome run.src/(plain ES modules, no build step),test/spec/,test/types/,types/,cli/,docs/, and the CI workflow.npm run dev(Karma watch in Chrome headless),npm run lint,npm run format,npm run test:cli,npm run test:typescript,npm run karma,npm run test:coverage, and what the fullnpm testruns.docs/, navigation in_sidebar.md/_navbar.md, how to add a page; note thatCHANGELOG.mdis generated bystandard-version.main, focused change + tests, runnpm test, the CITestworkflow steps (npm install→npm run test:setup→npm test).npm run release.Why
The repository has no contributing documentation, and #284 tracks exactly that gap. Without it, new contributors have to reverse-engineer the Karma/Playwright setup (
test:setup) and the individual checks from.github/workflows/test.yml.Verification
Every command documented in the guide was executed locally on this branch:
npm installnpm run test:clipass 5,fail 0npm run lintnpm run test:typescriptnpm run karma -- --browsers ChromeHeadlessnpm run test:setup(Playwright browser download) and the full three-browsernpm testwere not run locally; CI runs them exactly as documented. The Node.js 18+ requirement is taken fromenginesinpackage.json(CI uses Node 22).Closes #284