Imported from xilaluna/luna-handyman-solutions (
AGENTS.md). Install upstream withnpx skills add xilaluna/luna-handyman-solutions. Copyright stays with the author.
Repository Guidelines
Project Structure & Module Organization
- Astro 5 project with routes in
src/pages/*.astro;BaseLayout.astrocentralizes nav/footer and importssrc/styles/global.css. - Brand tokens and utility helpers live in
src/styles/global.css(Tailwind v4@theme; add new colors/spacing there). - Project copy and image references are in
src/data/projects.ts; corresponding assets reside undersrc/assets/(images/logos) while public icons live inpublic/. components/is available for reusable UI pieces; prefer colocating page-specific fragments near their route when possible.
Build, Test, and Development Commands
npm installto sync dependencies (lockfile ispackage-lock.json; use npm for consistency).npm run devto start the local server (Astro defaults to port 4321) with hot reload.npm run buildto produce a static build indist/; run before publishing changes.npm run previewto serve the built site for final QA.npm run astro checkfor Astro/TypeScript validation when editing layouts or data models.
Coding Style & Naming Conventions
- Use Astro/TypeScript modules with ES imports; prefer
constand typed props for layout/page data. - Keep markup semantic and responsive-first; lean on Tailwind utility classes already used in pages and layout.
- Extend design tokens through
@themeinglobal.css; reuse CSS utilities like.section-paddingand.section-containerfor spacing consistency. - For assets, use descriptive kebab-case filenames; place reusable media in
src/assets/and route-specific uploads alongside their data entry. - Add short comments only where they clarify intent (e.g., nav active-state logic, data mapping order); avoid restating obvious code.
Testing Guidelines
- No automated tests yet; perform manual sweeps after changes: nav highlighting, responsive layout at mobile/tablet/desktop, and correct rendering of project data cards.
- Run
npm run buildand, when touching data/layout logic,npm run astro checkto catch template or type errors before opening a PR.
Commit & Pull Request Guidelines
- Follow the existing history: short, present-tense summaries (
update projects.ts,Standardize section padding); avoid long prefixes. - Include PR details: what changed, why it’s needed, and any risk areas; attach before/after screenshots for visual updates and link related issues.
- Keep diffs focused; update or add data entries and assets together so reviewers can verify content in context.
Security & Configuration Tips
- Do not commit secrets; the project currently has no
.envneeds. If API keys are added later, document them and use environment variables. - Optimize images before adding to
src/assets/images/to keep the static build lean; prefer.jpegfor photos and.svgfor vector marks.
