|
| 1 | +# Repository Guidelines |
| 2 | + |
| 3 | +## Project Structure & Module Organization |
| 4 | +- Root HTML: `index.html`, `about-us.html`, `games.html`, `extended-reality.html`, `simulations.html`, error page `401.html`. |
| 5 | +- Styles: `css/` (site CSS), `style.css` (custom styles), `dist/css/` (Bootstrap builds), `css2/` (legacy styles). |
| 6 | +- Scripts: `js/` (site JS), `dist/js/` (Bootstrap builds), `js3D/`, `jsParticles/`, `particles/` (vendor lib with its own `package.json`). |
| 7 | +- Assets: `images/`, `img/` (legacy), `fonts/`, `Assets/Images/` and `Assets/fonts/` (legacy/brand assets), `video/`. |
| 8 | +- Server helper: `include/sendemail.php` (PHPMailer contact form). |
| 9 | + |
| 10 | +## Build, Test, and Development Commands |
| 11 | +- Serve locally: `python3 -m http.server 8080` (from repo root). Visit `http://localhost:8080`. |
| 12 | +- Quick link check: open DevTools Console and verify no 404/JS errors when navigating each page. |
| 13 | +- Vendor updates: keep Bootstrap files in `dist/` and third‑party libs in their folders; do not edit minified vendor files directly. |
| 14 | + |
| 15 | +## Coding Style & Naming Conventions |
| 16 | +- HTML/CSS/JS indentation: 4 spaces; trim trailing whitespace. |
| 17 | +- Filenames: lowercase, kebab‑case (e.g., `new-section.html`, `team-cards.css`). |
| 18 | +- JS: camelCase for variables/functions; keep code in `js/` and avoid inline scripts where possible. |
| 19 | +- CSS: prefer component‑scoped classes; avoid global overrides of vendor classes; place site styles in `css/` or `style.css` (keep Bootstrap overrides minimal and grouped). |
| 20 | +- Assets: place images in `images/`; web fonts in `fonts/`. Keep legacy assets in their existing legacy folders. |
| 21 | + |
| 22 | +## Testing Guidelines |
| 23 | +- No automated test harness currently. Manually verify: |
| 24 | + - Console is free of errors/warnings. |
| 25 | + - Responsive behavior at 480/800/1100/1500px (matches grid breakpoints used in `js/main.js`). |
| 26 | + - Lighthouse basic checks (Performance/Accessibility/SEO) for changed pages. |
| 27 | + |
| 28 | +## Commit & Pull Request Guidelines |
| 29 | +- Commits: short, imperative, sentence‑case summaries (e.g., "Fix carousel styles", "Add Game RAG section"). Group related changes. |
| 30 | +- PRs: clear description of changes, linked issues, before/after screenshots or screen recordings for UI updates, and a checklist confirming local testing across key pages. |
| 31 | + |
| 32 | +## Security & Configuration Tips |
| 33 | +- Do not commit secrets. For `include/sendemail.php`, configure PHPMailer via SMTP and reCAPTCHA server key via environment on the server; never store credentials in Git. |
| 34 | +- Validate contact recipients before enabling email; sanitize inputs and keep dependencies updated in vendor folders without modifying upstream code. |
0 commit comments