Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (50 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

64 lines (50 loc) · 1.64 KB
Raw

Contributing

Thanks for contributing to react-bot.

Scope

This repository is a public demo and portfolio project. Contributions are most useful when they improve one of these areas:

  • dashboard UX and accessibility
  • API reliability and typed contracts
  • Telegram bot flows
  • n8n automation templates
  • Docker/demo setup
  • documentation and repo discoverability

Development flow

  1. Fork the repository or create a feature branch from main.
  2. Keep changes focused and easy to review.
  3. Run local validation before opening a pull request.

Local validation

npm install
$env:DATABASE_URL='file:./dev.db'
npm --workspace apps/api run prisma:generate
npm --workspace apps/api run prisma:push
npm --workspace apps/api run prisma:seed
npm run lint
npm run build

If your change touches the runtime flow, also run:

$env:DATABASE_URL='file:./dev.db'
$env:JWT_SECRET='local-demo-secret'
$env:DEV_LOGIN_TOKEN='dev-token'
$env:ADMIN_TG_USER_ID='123456789'
$env:BOT_TOKEN='local-demo-bot-token'
npm run dev:api
$env:NEXT_PUBLIC_API_URL='http://localhost:3001/api'
$env:NEXT_PUBLIC_WS_URL='http://localhost:3001'
$env:NEXT_PUBLIC_DEV_LOGIN_TOKEN='dev-token'
npm run dev:web
$env:SMOKE_WEB_URL='http://localhost:3000'
$env:SMOKE_API_URL='http://localhost:3001/api'
$env:DEV_LOGIN_TOKEN='dev-token'
node scripts/e2e-smoke.mjs

Pull requests

  • Use a clear title and explain the user-facing impact.
  • Update README.md or docs when behavior changes.
  • Add or update screenshots when the UI changes materially.
  • Keep secrets, local exports, and private customer data out of the repository.