Skip to content

Add AI coding tool configuration files#2000

Open
lunacompsia-oss wants to merge 1 commit intohuntabyte:mainfrom
lunacompsia-oss:add-ai-config-files
Open

Add AI coding tool configuration files#2000
lunacompsia-oss wants to merge 1 commit intohuntabyte:mainfrom
lunacompsia-oss:add-ai-config-files

Conversation

@lunacompsia-oss
Copy link
Copy Markdown

What this PR does

Adds configuration files for AI coding tools so they better understand the bits-ui codebase:

  • CLAUDE.md — Project instructions for Claude Code (structure, commands, conventions)
  • .cursorrules — Context rules for Cursor AI
  • .windsurfrules — Context rules for Windsurf AI
  • .github/copilot-instructions.md — Instructions for GitHub Copilot

Why

AI coding tools work significantly better when they have project context. Without config files, they use generic behavior and miss framework-specific patterns (SvelteKit, Vite), project conventions, and build commands.

These files were generated by ai-ready, which analyzed the repo structure, languages, frameworks, and existing configs. The current AI readiness score is 80/100 (Grade B) — the missing AI config files are the main gap.

What each file does

File Tool Purpose
CLAUDE.md Claude Code Project overview, structure, key commands, conventions
.cursorrules Cursor Language/framework-specific coding rules
.windsurfrules Windsurf Same format as .cursorrules for Windsurf
.github/copilot-instructions.md GitHub Copilot Project context and coding guidelines

Notes

  • These are starting points — feel free to customize them to match your exact conventions
  • No existing files are modified
  • No dependencies added

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) <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants