-
Notifications
You must be signed in to change notification settings - Fork 22
Expand file tree
/
Copy pathproject-context.mdc
More file actions
32 lines (24 loc) Β· 1.64 KB
/
Copy pathproject-context.mdc
File metadata and controls
32 lines (24 loc) Β· 1.64 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
---
description: Core project identity and orientation for every agent session
globs:
alwaysApply: true
---
# Code Smells Catalog β Project Context
This is the **Code Smells Catalog** β a structured reference of 56 code smells, built by Marcel Jerzyk as a companion to his Springer Nature research paper and Master's thesis.
- Live at `https://codesmells.org` (Vercel) β **#1 Google result** for "code smells catalog"
- Legacy URL `https://luzkan.github.io/smells` redirects to codesmells.org
- Content lives in `content/smells/*.md` (56 files with rich YAML frontmatter) β this is the primary asset
- Built with **Astro 5**, Preact islands, Tailwind CSS v4, Nano Stores
- Deployed to **Vercel** as static output (no adapter)
## Critical constraints
- **Do not modify** the content frontmatter schema without explicit instruction
- **SEO is paramount** β preserve URL structure, canonical URLs, meta tags, sitemap, and redirects
- The Python `data_scraper/` reads the same markdown files β keep it working
- Internal links between smells use `./slug.md` β transformed by `src/plugins/remark-smell-links.ts`
## Key directories
- `content/smells/` β the 56 smell articles (Markdown + YAML frontmatter)
- `src/` β Astro application (components, layouts, pages, lib, stores, plugins)
- `scripts/` β build helpers (OG images, GH Pages redirects, sitemap verification)
- `tests/` β unit (Vitest), integration, E2E (Playwright)
- `.cursor/rules/` β agent context rules (content-model, architecture, deployment)
For the full frontmatter schema, see `content-model.mdc`. For architecture details, see `architecture.mdc`. For deployment, see `deployment.mdc`.