Skip to content

Commit 74532f0

Browse files
brunoborgesCopilot
andcommitted
Add copilot-instructions.md for workspace context
Provides Copilot with project overview, architecture, conventions, and a development checklist so it has context from the start of the workshop. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 80aa4fa commit 74532f0

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

.github/copilot-instructions.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Mona Mayhem — Copilot Workspace Instructions
2+
3+
## Development Checklist (mandatory)
4+
1. `npm run build` — ensure project compiles
5+
2. `npm run dev` — verify dev server runs without errors
6+
7+
## Project Overview
8+
- **What:** A retro arcade-themed GitHub Contribution Battle Arena
9+
- **Stack:** Astro v5, TypeScript, Node.js adapter (SSR)
10+
- **Entry point:** `src/pages/index.astro` — single-page battle UI
11+
- **API:** `src/pages/api/contributions/[username].ts` — proxies GitHub contribution data
12+
13+
## Architecture
14+
- Astro SSR with `@astrojs/node` adapter in standalone mode
15+
- Single-page app with inline styles and interactive JavaScript
16+
- Server-side API route fetches GitHub contribution graphs with 1-hour caching
17+
- No external UI framework — plain HTML/CSS/JS in `.astro` files
18+
19+
## Conventions
20+
- Use TypeScript for all new files
21+
- Keep styling scoped within Astro components or in dedicated CSS files
22+
- API routes go in `src/pages/api/`
23+
- Use semantic HTML elements for accessibility
24+
- Follow the retro arcade visual theme (pixel fonts, neon colors, scanline effects)

0 commit comments

Comments
 (0)