Skip to content

docs: add contributor guide - #32

Merged
leoncheng57 merged 1 commit into
mainfrom
docs/contributing-guide
Aug 21, 2026
Merged

docs: add contributor guide#32
leoncheng57 merged 1 commit into
mainfrom
docs/contributing-guide

Conversation

@leoncheng57

Copy link
Copy Markdown
Owner

Summary

  • add canonical contributor setup, architecture, conventions, verification, PR, screenshot, and security guidance
  • add a self-contained visual contributor reading index with file-safe links, responsive light/dark themes, accessible controls, and print support
  • link both contributor entry points from the project README

Files

  • CONTRIBUTING.md
  • docs/contributing/index.html
  • README.md

Verification

  • validated every documented npm run command against package.json
  • checked repository-relative targets across 24 Markdown files and the HTML index
  • confirmed new documentation is ASCII-only and git diff --check passes
  • visually checked the index from file:// at desktop and 390x740 mobile widths, including light/dark controls and horizontal overflow
  • npm run typecheck
  • npm test (231 passed)
  • npm run build
  • CI=1 npm run test:e2e (138 passed, 1 expected screenshot-runner skip)

@leoncheng57
leoncheng57 merged commit b4935c7 into main Aug 21, 2026
3 checks passed
@leoncheng57
leoncheng57 deleted the docs/contributing-guide branch August 21, 2026 22:08
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