Skip to content

Conversation

@jeromehardaway
Copy link
Contributor

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

  • Introduces the Vets Who Code LMS, outlining its tech stack (Next.js 15, TypeScript, Tailwind CSS, Prisma, NextAuth.js, AI integrations, Shopify, Jest, Playwright) and provides a detailed directory structure for the codebase.
  • Lists important files and describes their purposes (e.g., configuration, database schema, linting, and testing setups).

Development Guidelines

  • Documents commands for development, testing, linting, and formatting, as well as naming conventions, path aliases, and code style rules (e.g., component/function patterns, Tailwind prefix usage, TypeScript strict mode).
  • Provides key code patterns for components, API routes, and form handling, including code snippets for each.

Database and Environment

  • Summarizes the main Prisma database models and lists required environment variables for local development and deployment.

Testing and Workflow

  • Outlines testing guidelines (unit and E2E), common pitfallsAdd 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.

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.
@jeromehardaway jeromehardaway self-assigned this Nov 27, 2025
@vercel
Copy link

vercel bot commented Nov 27, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
vets-who-code-app Ready Ready Preview Comment Nov 27, 2025 11:01pm

Copy link
Contributor

Copilot AI left a 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.

Comment on lines +106 to +110
interface TProps {
className?: string;
}

const MyComponent = forwardRef<HTMLDivElement, TProps>(
Copy link

Copilot AI Nov 27, 2025

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.

Suggested change
interface TProps {
className?: string;
}
const MyComponent = forwardRef<HTMLDivElement, TProps>(
interface IProps {
className?: string;
}
const MyComponent = forwardRef<HTMLDivElement, IProps>(

Copilot uses AI. Check for mistakes.
- `DATABASE_URL` - PostgreSQL connection
- `NEXTAUTH_SECRET`, `NEXTAUTH_URL` - Authentication
- `GITHUB_CLIENT_ID`, `GITHUB_CLIENT_SECRET` - OAuth
- `PRIMARY_AI_PROVIDER`, AI API keys - AI assistant
Copy link

Copilot AI Nov 27, 2025

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.

Suggested change
- `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

Copilot uses AI. Check for mistakes.
Copy link
Contributor

@bhankee bhankee left a 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.

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.

4 participants