-
-
Notifications
You must be signed in to change notification settings - Fork 67
docs: add CLAUDE.md for AI-assisted development #832
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
docs: add CLAUDE.md for AI-assisted development #832
Conversation
Add comprehensive documentation for Claude AI to understand the codebase structure, conventions, and patterns. Includes tech stack, directory structure, naming conventions, code patterns, and testing guidelines.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds comprehensive AI-assisted development documentation in CLAUDE.md to help AI tools (like Claude) understand the codebase structure, conventions, and patterns for the Vets Who Code LMS application.
Key Changes:
- Documents the complete tech stack (Next.js 15, TypeScript, Tailwind CSS, Prisma, NextAuth.js, AI integrations, Shopify, Jest, Playwright)
- Provides detailed directory structure, naming conventions, code patterns, and development guidelines
- Lists database models, environment variables, testing guidelines, and common pitfalls
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| interface TProps { | ||
| className?: string; | ||
| } | ||
|
|
||
| const MyComponent = forwardRef<HTMLDivElement, TProps>( |
Copilot
AI
Nov 27, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The interface uses 'TProps' as its name, but according to the naming conventions table (line 78), interfaces should use the 'I-prefix' convention (e.g., 'IProps'), while type aliases use the 'T-prefix'. This example contradicts the documented naming convention.
| interface TProps { | |
| className?: string; | |
| } | |
| const MyComponent = forwardRef<HTMLDivElement, TProps>( | |
| interface IProps { | |
| className?: string; | |
| } | |
| const MyComponent = forwardRef<HTMLDivElement, IProps>( |
| - `DATABASE_URL` - PostgreSQL connection | ||
| - `NEXTAUTH_SECRET`, `NEXTAUTH_URL` - Authentication | ||
| - `GITHUB_CLIENT_ID`, `GITHUB_CLIENT_SECRET` - OAuth | ||
| - `PRIMARY_AI_PROVIDER`, AI API keys - AI assistant |
Copilot
AI
Nov 27, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing text between 'PRIMARY_AI_PROVIDER' and 'AI API keys'. Should be 'PRIMARY_AI_PROVIDER and AI API keys' or list the AI API keys as separate entries.
| - `PRIMARY_AI_PROVIDER`, AI API keys - AI assistant | |
| - `PRIMARY_AI_PROVIDER`, `OPENAI_API_KEY`, `AZURE_OPENAI_API_KEY`, `GEMINI_API_KEY`, `PHI3_API_KEY` - AI assistant |
bhankee
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great overview of tech stack and will help with the AI implementation.
This pull request adds a comprehensive project documentation file,
CLAUDE.md, for the Vets Who Code LMS app. The new documentation provides an overview of the tech stack, directory structure, coding conventions, key patterns, and important guidelines for development and contribution.Key documentation additions:
Project Overview and Structure
Development Guidelines
Database and Environment
Testing and Workflow