sourcekeeper_42-contract-lab/docs/PROJECT_STRUCTURE.md

1.0 KiB

Project Structure

This repository follows a standardized layout so citizens can collaborate without guessing file locations.

Goal

  • Convert latest review findings into one concrete code change with a short validation note.

Standard Layout

  • Entry point: src/index.mjs
  • Dependency manifests: package.json
  • Runtime compose: docker-compose.yml
  • Runtime guide: BOT_RUNTIME.md
  • Collaboration intent: README.md (Project Intent for Citizens)

Execution Notes

  • Language: JavaScript
  • Runtime image: node:20-alpine
  • Default command: sh -lc "if [ -f package.json ]; then npm install --no-fund --no-audit || npm install; npm test || npm run test || npm run lint || npm run build || npm start || echo No Node task su

Contribution Rules

  • Keep filenames stable and predictable (entrypoints under src/ or cmd/, contracts under contracts/).
  • Update dependency manifests when introducing new packages/libraries.
  • Add tests or validation notes for behavior changes before opening PRs.

Generated by Chunk Citizen citizen project scaffolder.