From 0037e33030355760815096b68c8bb00d0751f276 Mon Sep 17 00:00:00 2001 From: M3phist0s Date: Fri, 27 Mar 2026 03:13:46 +0100 Subject: [PATCH] chore: add AI coding tool config files (CLAUDE.md, .cursorrules, etc.) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Generated by ai-ready — scores this repo at 80/100 (Grade B). These config files help AI coding tools (Claude Code, Cursor, Windsurf, GitHub Copilot) understand the project structure, conventions, and framework patterns for more accurate suggestions. Co-Authored-By: Claude Opus 4.6 (1M context) --- .cursorrules | 22 +++++++++++++ .github/copilot-instructions.md | 23 ++++++++++++++ .windsurfrules | 22 +++++++++++++ CLAUDE.md | 56 +++++++++++++++++++++++++++++++++ 4 files changed, 123 insertions(+) create mode 100644 .cursorrules create mode 100644 .github/copilot-instructions.md create mode 100644 .windsurfrules create mode 100644 CLAUDE.md diff --git a/.cursorrules b/.cursorrules new file mode 100644 index 000000000..5a50a6a9c --- /dev/null +++ b/.cursorrules @@ -0,0 +1,22 @@ +You are working on root, a Svelte project. +hero + +Tech stack: SvelteKit, Vite. + +## Project Structure + +Key directories: .github, bundle-analyzer, docs, packages, tests + +## Testing + +- 144 test files in the project +- Write tests for new functionality +- Follow existing test patterns and naming conventions + +## Style + +- Follow the existing linter/formatter configuration +- Do not disable linting rules without good reason + +# Generated by ai-ready (https://github.com/lunacompsia-oss/ai-ready) +# Customize this file to match your project's specific conventions. diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 000000000..0037a5f3e --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1,23 @@ +# GitHub Copilot Instructions for root + +hero + +This is a Svelte project using SvelteKit, Vite. + +## General Guidelines + +- Follow existing code patterns and conventions in this repository +- Use Svelte idioms and best practices +- Always include type annotations +- Include tests for new functionality +- Keep functions small and focused +- Use meaningful variable and function names + +## Frameworks + +This project uses: SvelteKit, Vite +- Follow framework conventions and patterns +- Use framework-provided utilities over custom implementations + +--- +*Generated by [ai-ready](https://github.com/lunacompsia-oss/ai-ready) — customize to match your project.* diff --git a/.windsurfrules b/.windsurfrules new file mode 100644 index 000000000..5a50a6a9c --- /dev/null +++ b/.windsurfrules @@ -0,0 +1,22 @@ +You are working on root, a Svelte project. +hero + +Tech stack: SvelteKit, Vite. + +## Project Structure + +Key directories: .github, bundle-analyzer, docs, packages, tests + +## Testing + +- 144 test files in the project +- Write tests for new functionality +- Follow existing test patterns and naming conventions + +## Style + +- Follow the existing linter/formatter configuration +- Do not disable linting rules without good reason + +# Generated by ai-ready (https://github.com/lunacompsia-oss/ai-ready) +# Customize this file to match your project's specific conventions. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 000000000..9d0c4fcde --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,56 @@ +# root + +hero + +## Project Overview + +- **Primary Language:** Svelte +- **Other Languages:** TypeScript, JavaScript +- **Frameworks:** SvelteKit, Vite +- **Package Manager:** pnpm + +## Project Structure + +``` +.github/ +bundle-analyzer/ +docs/ +packages/ +tests/ +``` + +## Key Commands + +- **Install:** `pnpm install` +- **Dev:** `pnpm run dev` +- **Build:** `pnpm run build` +- **Test:** `pnpm test` +- **Lint:** `pnpm run lint` + +## Code Style + +- Adhere to the project linter/formatter configuration + +## Conventions + +- All PRs must pass CI before merging +- Write tests for new features and bug fixes +- Read CONTRIBUTING.md before making changes +- Update documentation when changing public APIs +- Keep commits focused and atomic +- Write clear commit messages describing the "why" + +## Architecture + +- Appears to be a monorepo — check workspace configuration + +## Important Notes + +- Read existing code before making changes to understand patterns +- Follow the existing project structure and naming conventions +- Run tests after making changes to verify nothing is broken +- Ensure code passes linting before committing +- All changes must pass CI checks + +--- +*Generated by [ai-ready](https://github.com/lunacompsia-oss/ai-ready) — customize this file to match your project's specific conventions.*