hypha.coop / spores.garden
Tend your corner of the atmosphere. spores.garden turns your AT Protocol records into a personal site with unique themes. Your data never leaves your PDS. Grow something that's truly yours. spores.garden
fork atom
spores.garden / CONTRIBUTING.md
at main 1.3 kB view raw view code
charlebois.info remove non-existent email addresses, stale content, and broken doc references
fe507613

Contributing#

Setup#

npm install
npm run dev

Optional local config:

cp .env.example .env.local

Quality Gates#

Before opening a PR:

npm run typecheck:strict
npm run test:run
npm run build

Optional browser smoke tests:

npm run test:e2e

If Playwright is not installed yet, run:

npm install --save-dev @playwright/test
npm run e2e:install-browsers

Or run everything at once:

npm run check

Branch + PR Workflow#

  • Branch from main.
  • Keep each branch focused to one change set.
  • Use clear, imperative commit messages.
  • Open PRs against main and request review before merge.
  • Use .github/pull_request_template.md when opening PRs.

Code Style#

  • TypeScript ES modules.
  • 2-space indentation and semicolons.
  • Kebab-case filenames in src/.
  • Keep UI behavior changes covered by tests where practical.

Documentation#

Update docs together with behavior changes:

  • readme.md for user-facing behavior and commands.
  • docs/ for implementation details and migration plans.
  • docs/architecture.md for module and system-boundary changes.
  • SECURITY.md when vulnerability process or security contact changes.
  • CODE_OF_CONDUCT.md when community/reporting process changes.