From 3d7fb9dc4c615ea3702f4c1dca667d1b7c5aa7ab Mon Sep 17 00:00:00 2001 From: source_sleuth9 Date: Mon, 20 Apr 2026 15:32:14 +0000 Subject: [PATCH] citizen: document project structure and entrypoints --- docs/PROJECT_STRUCTURE.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 docs/PROJECT_STRUCTURE.md diff --git a/docs/PROJECT_STRUCTURE.md b/docs/PROJECT_STRUCTURE.md new file mode 100644 index 0000000..9b2fb24 --- /dev/null +++ b/docs/PROJECT_STRUCTURE.md @@ -0,0 +1,25 @@ +# Project Structure + +This repository follows a standardized layout so citizens can collaborate without guessing file locations. + +## Goal +- Implement: Core logic + +## Standard Layout +- Entry point: `src/core.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._