Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (28 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

45 lines (28 loc) · 2.48 KB
Raw

Contributing

TypeSpeed is plain HTML, CSS, and JavaScript with no build step. The files in the repo root are the site; GitHub Pages publishes them from main after CI passes.

Setup

npm install
npx playwright install chromium firefox webkit
npm run serve    # http://127.0.0.1:8765, caching off

Before you push

npm run check runs ESLint, the Prettier check, and the Playwright tests in Chromium, Firefox, and WebKit. It must pass. CI runs the same steps on every push and pull request.

Every bug fix needs a test in tests/ that fails without the fix. Tests drive the real page with keystrokes. Use page.clock for anything that depends on elapsed time instead of waiting.

Code style

  • 4-space indentation, single quotes, semicolons, lines up to 100 characters. npm run format applies this.
  • script.js is a classic script, not a module. Group code under // --- Section --- banner comments.
  • DOM references are module-level consts at the top of script.js. A new element in index.html needs one there.
  • Settings live in gameState (saved) and per-run data in runtime (reset by resetGame).
  • Put passage text on the page with textContent, never innerHTML.
  • Colors go through the custom properties in style.css so every theme can override them. Do not write transition: all.
  • Passages, word lists, and code snippets are in texts.js. Give a quote a source only when you can confirm the attribution.

Adding quotes, snippets, and word lists

You do not need to change code to propose text. Open an issue with one of the forms: quote, code snippet, or word list. Each asks for the source and license. Accepted proposals get the good first issue label, so anyone can add them to texts.js.

tests/texts.spec.js checks texts.js in CI: every character can be typed on a US keyboard (printable ASCII, no tabs or curly quotes), quotes are unique and at most 300 characters, snippets are unique, 2 to 9 lines, with lines of at most 100 characters and no trailing spaces, and common words are unique lowercase letters.

Docs

README and comments say what the code does. No claims about quality or speed, and no features that are not in the code.

Commits

Sentence-style imperative subjects, for example "Add settings modal" or "Fix hidden modals".

Security problems

Do not open a public issue. See SECURITY.md for how to report one privately.