|
| 1 | +project: |
| 2 | + name: NepaLingo |
| 3 | + summary: >- |
| 4 | + Web application for learning Nepal's indigenous languages built with React + |
| 5 | + TypeScript (Vite). Repository also includes a lightweight Python bot that |
| 6 | + relays Supabase feedback to Discord. |
| 7 | + default_branch: main |
| 8 | + code_paths: |
| 9 | + - nepalingo-web/src |
| 10 | + - bhasa-bot |
| 11 | + languages: |
| 12 | + - TypeScript |
| 13 | + - React |
| 14 | + - TailwindCSS |
| 15 | + - Python |
| 16 | + |
| 17 | +workflow: |
| 18 | + issue_labels: |
| 19 | + include: |
| 20 | + - codex-ready |
| 21 | + - good-first-issue |
| 22 | + exclude: |
| 23 | + - blocked |
| 24 | + - needs-design |
| 25 | + branch_template: issue/{issue_number}-{slug} |
| 26 | + pr_title_template: "[{issue_number}] {issue_title}" |
| 27 | + commit_message_guidance: >- |
| 28 | + Use concise, active commit subjects (e.g., "feat: add XYZ" or "fix: |
| 29 | + address ABC") and reference the issue number in the PR description. |
| 30 | + definition_of_done: |
| 31 | + - Lint, format-check, and build commands succeed. |
| 32 | + - Relevant documentation, config, and Supabase SQL files updated alongside code. |
| 33 | + - New UI strings include fallbacks or translation placeholders. |
| 34 | + |
| 35 | +environment: |
| 36 | + prerequisites: |
| 37 | + node: "20" |
| 38 | + package_manager: pnpm@8 |
| 39 | + python: "3.11" |
| 40 | + setup: |
| 41 | + - run: pnpm install |
| 42 | + cwd: nepalingo-web |
| 43 | + - run: pip install -r requirements.txt |
| 44 | + cwd: bhasa-bot |
| 45 | + commands: |
| 46 | + lint: |
| 47 | + - run: pnpm run lint |
| 48 | + cwd: nepalingo-web |
| 49 | + format_check: |
| 50 | + - run: pnpm run format-check |
| 51 | + cwd: nepalingo-web |
| 52 | + format_write: |
| 53 | + - run: pnpm run format |
| 54 | + cwd: nepalingo-web |
| 55 | + build: |
| 56 | + - run: pnpm run build |
| 57 | + cwd: nepalingo-web |
| 58 | + preview: |
| 59 | + - run: pnpm run dev |
| 60 | + cwd: nepalingo-web |
| 61 | + python_lint: [] |
| 62 | + required_checks: |
| 63 | + - lint |
| 64 | + - format_check |
| 65 | + - build |
| 66 | + |
| 67 | +prompts: |
| 68 | + coding_standards: |- |
| 69 | + - Prefer functional React components with explicit prop typing. |
| 70 | + - Keep Tailwind class strings organized by layout, spacing, typography, then color. |
| 71 | + - Use React Router data APIs already present; avoid introducing redundant routing helpers. |
| 72 | + - When touching Supabase interactions, reuse the existing client utilities and handle loading/error states. |
| 73 | + testing_guidance: |- |
| 74 | + - Run the listed required checks before submitting a PR. |
| 75 | + - Add ad-hoc scripts under scripts/ only when they include usage documentation. |
| 76 | + doc_expectations: |- |
| 77 | + - Update README sections or in-app copy when behavior or entry points change. |
| 78 | + - Surface notable environment variable changes in PR descriptions. |
| 79 | + review_prompt: |- |
| 80 | + Provide a short summary, list of key changes, test evidence, and open questions in the PR body. |
0 commit comments