RuleStack

Configs

Stacks

Compare

Diff

RuleStack

Configs

Stacks

Compare

Diff

Read API

RuleStack

Configs

Stacks

Compare

Diff

Read API

Diff/herringtondarkholme-megarepo-github-copilot-instructions ↔ herringtondarkholme-megarepo-cursor-rules-project-structure

Comparison

A · Copilot instructions · HerringtonDarkholme/megarepoB · Cursor rules · HerringtonDarkholme/megarepo
What each file covers, counted
DimensionSharedOnly in AOnly in BOverlap
Sections042110%
Commands01100%
Section tags11028%

What each file covers

Sections

0 shared · 42 only in A · 11 only in B
  • − Megarepo - AI Setup Repository
  • − Repository Overview
  • − Current Repository State
  • − Working Effectively
  • − Initial Repository Exploration
  • − Always start by understanding the current repository state
  • − When Source Code is Added
  • − Check for package.json first
  • − If package.json exists, install dependencies
  • − NEVER CANCEL: npm install typically takes 2-5 minutes. Set timeout to 10+ minutes.
  • − Common build commands (verify these exist in package.json first)
  • − NEVER CANCEL: Build may take 5-45 minutes depending on project size. Set timeout to 60+ minutes.
  • − Common test commands
  • − NEVER CANCEL: Tests may take 5-15 minutes. Set timeout to 30+ minutes.
  • − Common development server
  • − Check for linting configuration
  • − Run linting if configured
  • − Run formatting if configured
  • − Run type checking if TypeScript
  • − Repository Structure Expectations
  • − Validation Requirements
  • − Before Making Changes
  • − After Making Changes
  • − Common Commands Reference
  • − Repository Information
  • − View current files
  • − Check git status
  • − View repository structure
  • − When Package.json Exists
  • − View available scripts
  • − Install dependencies
  • − TIMEOUT: 10+ minutes
  • − Common development commands (check package.json first)
  • − File Locations and Navigation
  • − Current Key Files
  • − Expected Important Locations (when populated)
  • − AI Development Guidelines
  • − Troubleshooting
  • − Repository Appears Empty
  • − Build Failures
  • − Development Server Issues
  • − Critical Reminders
  • + Project Structure & Architecture
  • + Expected Project Structure
  • + Key Directory Guidelines
  • + Source Code Organization
  • + Component Organization
  • + Utility Organization
  • + Architectural Principles
  • + 1. Node.js/Next.js Development
  • + 2. File Naming Conventions
  • + 3. Import Organization
  • + 4. Configuration Management

Commands

0 shared · 11 only in A · 0 only in B
  • − git status
  • − npm install
  • − npm run build
  • − npm test
  • − npm run dev
  • − npm run lint
  • − npm run format
  • − npm run type-check
  • − npm run start
  • − npm run test
  • − git branch -a

Section tags

1 shared · 10 only in A · 2 only in B
  • − setup
  • − build
  • − test
  • − lint-format
  • − types
  • − git-pr
  • − security
  • − dependencies
  • − do-not
  • − agent-behaviour
  • + code-style
  • + ui
  •   architecture

Line diff

+54 added−205 removed20 unchanged8.9% identical
HerringtonDarkholme/megarepo · .github/copilot-instructions.md
@@ −1 @@
1# Megarepo - AI Setup Repository
 
 
 
 
2 
3**ALWAYS follow these instructions first and only fallback to additional search and context gathering if the information here is incomplete or found to be in error.**
4 
5## Repository Overview
6 
7Megarepo is currently a minimal repository template designed for AI-related projects. The repository contains basic setup files and is configured for Node.js/Next.js development based on the .gitignore patterns.
8 
9## Current Repository State
10 
11**IMPORTANT**: This repository is currently in a minimal state with only basic setup files:
12- README.md (basic project description)
13- LICENSE (MIT license)
14- .gitignore (configured for Node.js/Next.js projects)
15 
16**DO NOT attempt to build, test, or run code** - there is no source code or build system present yet.
17 
18## Working Effectively
19 
20### Initial Repository Exploration
21```bash
22# Always start by understanding the current repository state
23ls -la
24git status
25find . -type f -name "*.json" -o -name "*.js" -o -name "*.ts" -o -name "*.md"
26```
27 
28### When Source Code is Added
29 
30The repository is pre-configured for Node.js/Next.js development. When source code is added, follow these patterns:
31 
32#### Node.js/Next.js Project Setup
33```bash
34# Check for package.json first
35ls package.json
36 
37# If package.json exists, install dependencies
38npm install
39# NEVER CANCEL: npm install typically takes 2-5 minutes. Set timeout to 10+ minutes.
40 
41# Common build commands (verify these exist in package.json first)
42npm run build
43# NEVER CANCEL: Build may take 5-45 minutes depending on project size. Set timeout to 60+ minutes.
44 
45# Common test commands
46npm test
47# NEVER CANCEL: Tests may take 5-15 minutes. Set timeout to 30+ minutes.
48 
49# Common development server
50npm run dev
51```
52 
53#### Pre-commit Validation
54When source code exists, always run these before committing:
55```bash
56# Check for linting configuration
57ls .eslintrc* eslint.config.* .prettierrc*
58 
59# Run linting if configured
60npm run lint
61 
62# Run formatting if configured
63npm run format
64 
65# Run type checking if TypeScript
66npm run type-check
67```
68 
69## Repository Structure Expectations
70 
71Based on the .gitignore configuration, expect the following when the repository is populated:
72 
73```
74.
75├── README.md # Project documentation
76├── LICENSE # MIT license
77├── .gitignore # Node.js/Next.js ignore patterns
78├── package.json # Node.js dependencies and scripts
79├── package-lock.json # Dependency lockfile
80├── next.config.js # Next.js configuration (if Next.js)
81├── tsconfig.json # TypeScript configuration (if TypeScript)
82├── .eslintrc.* # ESLint configuration
83├── .prettierrc # Prettier configuration
84├── src/ # Source code directory
85│ ├── pages/ # Next.js pages (if Next.js)
86│ ├── components/ # React components
87│ └── utils/ # Utility functions
 
 
88├── public/ # Static assets
89├── .next/ # Next.js build output (ignored)
90├── build/ # Build output (ignored)
91└── node_modules/ # Dependencies (ignored)
92```
93 
94## Validation Requirements
95 
96### Before Making Changes
971. **Always check current repository state first**:
98 ```bash
99 git status
100 ls -la
101 cat package.json # Only if it exists
102 ```
103 
1042. **Verify build system exists before attempting builds**:
105 ```bash
106 # Check for package.json before running npm commands
107 test -f package.json && echo "Node.js project detected" || echo "No package.json found"
108 ```
109 
110### After Making Changes
1111. **When source code is present, always validate**:
112 ```bash
113 # Install dependencies if package.json exists
114 test -f package.json && npm install
115
116 # Build if build script exists
117 test -f package.json && npm run build
118
119 # Test if test script exists
120 test -f package.json && npm test
121
122 # Lint if lint script exists
123 test -f package.json && npm run lint
124 ```
125 
1262. **Manual validation scenarios when application exists**:
127 - Start the development server and verify it loads
128 - Test basic functionality by navigating through the application
129 - Verify any API endpoints respond correctly
130 - Check console for errors
131 
132## Common Commands Reference
 
 
 
 
 
133 
134### Repository Information
135```bash
136# View current files
137ls -la
 
138 
139# Check git status
140git status
 
 
141 
142# View repository structure
143tree . -a -I 'node_modules|.git' # If tree is available (use -a to show hidden files)
144find . -type f -not -path "./.git/*" -not -path "./node_modules/*" | sort
145```
146 
147### When Package.json Exists
148```bash
149# View available scripts
150cat package.json | grep -A 20 '"scripts"'
151 
152# Install dependencies
153npm install
154# TIMEOUT: 10+ minutes
155 
156# Common development commands (check package.json first)
157npm run dev # Development server
158npm run build # Production build
159npm run start # Start production server
160npm run test # Run tests
161npm run lint # Run linter
162npm run format # Format code
163```
164 
165## File Locations and Navigation
166 
167### Current Key Files
168- `/README.md` - Project overview and setup instructions
169- `/LICENSE` - MIT license terms
170- `/.gitignore` - Git ignore patterns (Node.js/Next.js focused)
171 
172### Expected Important Locations (when populated)
173- `/src/` - Main source code directory
174- `/src/pages/` - Next.js pages (if Next.js project)
175- `/src/components/` - React components
176- `/public/` - Static assets and files
177- `/package.json` - Project configuration and dependencies
178- `/next.config.js` - Next.js configuration
179- `/tsconfig.json` - TypeScript configuration
180 
181## AI Development Guidelines
182 
183Since this is an AI setup repository:
184 
1851. **Always verify AI-related dependencies** when they are added:
186 ```bash
187 # Common AI packages to look for
188 grep -E "(openai|langchain|tensorflow|pytorch|huggingface)" package.json
189 ```
190 
1912. **Environment variables for AI services**:
192 ```bash
193 # Check for environment configuration
194 ls .env* || echo "No environment files found"
195 ```
196 
1973. **API key management**:
198 - Never commit API keys
199 - Always use environment variables
200 - Check .env.example for required variables
201 
202## Troubleshooting
203 
204### Repository Appears Empty
205- This is expected in the current state
206- Check git branch: `git branch -a`
207- Look for other branches that might contain code
208 
209### Build Failures
210- First verify package.json exists: `ls package.json`
211- Clear dependencies and reinstall: `rm -rf node_modules package-lock.json && npm install`
212- Check Node.js version compatibility in package.json
213 
214### Development Server Issues
215- Verify port availability (typically 3000 for Next.js)
216- Check for environment variable requirements
217- Review console output for specific error messages
218 
219## Critical Reminders
220 
221- **NEVER CANCEL builds or long-running commands** - they may take 45+ minutes
222- **ALWAYS validate commands work** before assuming functionality exists
223- **CHECK for package.json** before running npm commands
224- **SET APPROPRIATE TIMEOUTS** - builds: 60+ minutes, tests: 30+ minutes
225- **VERIFY repository state** before attempting any operations
HerringtonDarkholme/megarepo · .cursor/rules/project-structure.mdc
@@ +1 @@
1---
2description: "File organization and architectural patterns for the AI setup repository"
3globs: ["src/**/*", "app/**/*", "public/**/*", "docs/**/*"]
4alwaysApply: false
5---
6 
7# Project Structure & Architecture
8 
9Guidelines for organizing files and structuring the AI setup repository.
10 
11## Expected Project Structure
12 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
13```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
14.
15├── README.md # Project documentation
16├── LICENSE # MIT license
17├── .gitignore # Node.js/Next.js patterns
18├── .cursor/rules/ # Cursor project rules
19├── .env.example # Environment variable template
20├── package.json # Dependencies and scripts
21├── next.config.js # Next.js configuration
22├── tsconfig.json # TypeScript configuration
23├── src/
24│ ├── app/ # Next.js app directory
 
25│ ├── components/ # React components
26│ ├── lib/ # Utility functions and AI clients
27│ ├── types/ # TypeScript type definitions
28│ └── utils/ # Helper functions
29├── public/ # Static assets
30└── docs/ # Additional documentation
 
 
31```
32 
33## Key Directory Guidelines
34 
35### Source Code Organization
36- `src/lib/` - Place AI client configurations and utilities here
37- `src/components/` - Reusable UI components, including AI-powered components
38- `src/app/api/` - API routes for AI services and integrations
39- `src/types/` - TypeScript definitions for AI responses and data models
 
 
40 
41### Component Organization
42- Group related components in feature-specific subdirectories
43- Keep component styles and tests near the component
44- Use index files for clean imports
 
45 
46### Utility Organization
47- Group related utilities in feature-specific directories
48- Separate AI-specific utilities from general utilities
49- Implement consistent naming patterns
 
 
 
 
 
 
 
 
 
 
 
50 
51## Architectural Principles
 
 
 
 
52 
53### 1. Node.js/Next.js Development
54- Follow Next.js 13+ App Router patterns when applicable
55- Use modern ES6+ JavaScript/TypeScript features
56- Implement proper async/await patterns for AI API calls
57- Use React Server Components where appropriate
58- Optimize for both development and production environments
59 
60### 2. File Naming Conventions
61- Use camelCase for JavaScript/TypeScript files
62- Use PascalCase for React component files
63- Use kebab-case for API routes and static files
64- Use descriptive names that indicate purpose
65 
66### 3. Import Organization
67- Group imports by type (external, internal, relative)
68- Use absolute imports with path aliases when configured
69- Keep imports organized and clean
70 
71### 4. Configuration Management
72- Keep all configuration files in the project root
73- Use TypeScript for configuration files when possible
74- Document configuration options and their purposes
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
@@ −1 +1 @@
1−# Megarepo - AI Setup Repository
1+---
2+description: "File organization and architectural patterns for the AI setup repository"
3+globs: ["src/**/*", "app/**/*", "public/**/*", "docs/**/*"]
4+alwaysApply: false
5+---
26  
3−**ALWAYS follow these instructions first and only fallback to additional search and context gathering if the information here is incomplete or found to be in error.**
7+# Project Structure & Architecture
48  
5−## Repository Overview
9+Guidelines for organizing files and structuring the AI setup repository.
610  
7−Megarepo is currently a minimal repository template designed for AI-related projects. The repository contains basic setup files and is configured for Node.js/Next.js development based on the .gitignore patterns.
11+## Expected Project Structure
812  
9−## Current Repository State
10− 
11−**IMPORTANT**: This repository is currently in a minimal state with only basic setup files:
12−- README.md (basic project description)
13−- LICENSE (MIT license)
14−- .gitignore (configured for Node.js/Next.js projects)
15− 
16−**DO NOT attempt to build, test, or run code** - there is no source code or build system present yet.
17− 
18−## Working Effectively
19− 
20−### Initial Repository Exploration
21−```bash
22−# Always start by understanding the current repository state
23−ls -la
24−git status
25−find . -type f -name "*.json" -o -name "*.js" -o -name "*.ts" -o -name "*.md"
2613 ```
27− 
28−### When Source Code is Added
29− 
30−The repository is pre-configured for Node.js/Next.js development. When source code is added, follow these patterns:
31− 
32−#### Node.js/Next.js Project Setup
33−```bash
34−# Check for package.json first
35−ls package.json
36− 
37−# If package.json exists, install dependencies
38−npm install
39−# NEVER CANCEL: npm install typically takes 2-5 minutes. Set timeout to 10+ minutes.
40− 
41−# Common build commands (verify these exist in package.json first)
42−npm run build
43−# NEVER CANCEL: Build may take 5-45 minutes depending on project size. Set timeout to 60+ minutes.
44− 
45−# Common test commands
46−npm test
47−# NEVER CANCEL: Tests may take 5-15 minutes. Set timeout to 30+ minutes.
48− 
49−# Common development server
50−npm run dev
51−```
52− 
53−#### Pre-commit Validation
54−When source code exists, always run these before committing:
55−```bash
56−# Check for linting configuration
57−ls .eslintrc* eslint.config.* .prettierrc*
58− 
59−# Run linting if configured
60−npm run lint
61− 
62−# Run formatting if configured
63−npm run format
64− 
65−# Run type checking if TypeScript
66−npm run type-check
67−```
68− 
69−## Repository Structure Expectations
70− 
71−Based on the .gitignore configuration, expect the following when the repository is populated:
72− 
73−```
7414 .
7515 ├── README.md # Project documentation
7616 ├── LICENSE # MIT license
77−├── .gitignore # Node.js/Next.js ignore patterns
78−├── package.json # Node.js dependencies and scripts
79−├── package-lock.json # Dependency lockfile
80−├── next.config.js # Next.js configuration (if Next.js)
81−├── tsconfig.json # TypeScript configuration (if TypeScript)
82−├── .eslintrc.* # ESLint configuration
83−├── .prettierrc # Prettier configuration
84−├── src/ # Source code directory
85−│ ├── pages/ # Next.js pages (if Next.js)
17+├── .gitignore # Node.js/Next.js patterns
18+├── .cursor/rules/ # Cursor project rules
19+├── .env.example # Environment variable template
20+├── package.json # Dependencies and scripts
21+├── next.config.js # Next.js configuration
22+├── tsconfig.json # TypeScript configuration
23+├── src/
24+│ ├── app/ # Next.js app directory
8625 │ ├── components/ # React components
87−│ └── utils/ # Utility functions
26+│ ├── lib/ # Utility functions and AI clients
27+│ ├── types/ # TypeScript type definitions
28+│ └── utils/ # Helper functions
8829 ├── public/ # Static assets
89−├── .next/ # Next.js build output (ignored)
90−├── build/ # Build output (ignored)
91−└── node_modules/ # Dependencies (ignored)
30+└── docs/ # Additional documentation
9231 ```
9332  
94−## Validation Requirements
33+## Key Directory Guidelines
9534  
96−### Before Making Changes
97−1. **Always check current repository state first**:
98− ```bash
99− git status
100− ls -la
101− cat package.json # Only if it exists
102− ```
35+### Source Code Organization
36+- `src/lib/` - Place AI client configurations and utilities here
37+- `src/components/` - Reusable UI components, including AI-powered components
38+- `src/app/api/` - API routes for AI services and integrations
39+- `src/types/` - TypeScript definitions for AI responses and data models
10340  
104−2. **Verify build system exists before attempting builds**:
105− ```bash
106− # Check for package.json before running npm commands
107− test -f package.json && echo "Node.js project detected" || echo "No package.json found"
108− ```
41+### Component Organization
42+- Group related components in feature-specific subdirectories
43+- Keep component styles and tests near the component
44+- Use index files for clean imports
10945  
110−### After Making Changes
111−1. **When source code is present, always validate**:
112− ```bash
113− # Install dependencies if package.json exists
114− test -f package.json && npm install
115−
116− # Build if build script exists
117− test -f package.json && npm run build
118−
119− # Test if test script exists
120− test -f package.json && npm test
121−
122− # Lint if lint script exists
123− test -f package.json && npm run lint
124− ```
46+### Utility Organization
47+- Group related utilities in feature-specific directories
48+- Separate AI-specific utilities from general utilities
49+- Implement consistent naming patterns
12550  
126−2. **Manual validation scenarios when application exists**:
127− - Start the development server and verify it loads
128− - Test basic functionality by navigating through the application
129− - Verify any API endpoints respond correctly
130− - Check console for errors
51+## Architectural Principles
13152  
132−## Common Commands Reference
53+### 1. Node.js/Next.js Development
54+- Follow Next.js 13+ App Router patterns when applicable
55+- Use modern ES6+ JavaScript/TypeScript features
56+- Implement proper async/await patterns for AI API calls
57+- Use React Server Components where appropriate
58+- Optimize for both development and production environments
13359  
134−### Repository Information
135−```bash
136−# View current files
137−ls -la
60+### 2. File Naming Conventions
61+- Use camelCase for JavaScript/TypeScript files
62+- Use PascalCase for React component files
63+- Use kebab-case for API routes and static files
64+- Use descriptive names that indicate purpose
13865  
139−# Check git status
140−git status
66+### 3. Import Organization
67+- Group imports by type (external, internal, relative)
68+- Use absolute imports with path aliases when configured
69+- Keep imports organized and clean
14170  
142−# View repository structure
143−tree . -a -I 'node_modules|.git' # If tree is available (use -a to show hidden files)
144−find . -type f -not -path "./.git/*" -not -path "./node_modules/*" | sort
145−```
146− 
147−### When Package.json Exists
148−```bash
149−# View available scripts
150−cat package.json | grep -A 20 '"scripts"'
151− 
152−# Install dependencies
153−npm install
154−# TIMEOUT: 10+ minutes
155− 
156−# Common development commands (check package.json first)
157−npm run dev # Development server
158−npm run build # Production build
159−npm run start # Start production server
160−npm run test # Run tests
161−npm run lint # Run linter
162−npm run format # Format code
163−```
164− 
165−## File Locations and Navigation
166− 
167−### Current Key Files
168−- `/README.md` - Project overview and setup instructions
169−- `/LICENSE` - MIT license terms
170−- `/.gitignore` - Git ignore patterns (Node.js/Next.js focused)
171− 
172−### Expected Important Locations (when populated)
173−- `/src/` - Main source code directory
174−- `/src/pages/` - Next.js pages (if Next.js project)
175−- `/src/components/` - React components
176−- `/public/` - Static assets and files
177−- `/package.json` - Project configuration and dependencies
178−- `/next.config.js` - Next.js configuration
179−- `/tsconfig.json` - TypeScript configuration
180− 
181−## AI Development Guidelines
182− 
183−Since this is an AI setup repository:
184− 
185−1. **Always verify AI-related dependencies** when they are added:
186− ```bash
187− # Common AI packages to look for
188− grep -E "(openai|langchain|tensorflow|pytorch|huggingface)" package.json
189− ```
190− 
191−2. **Environment variables for AI services**:
192− ```bash
193− # Check for environment configuration
194− ls .env* || echo "No environment files found"
195− ```
196− 
197−3. **API key management**:
198− - Never commit API keys
199− - Always use environment variables
200− - Check .env.example for required variables
201− 
202−## Troubleshooting
203− 
204−### Repository Appears Empty
205−- This is expected in the current state
206−- Check git branch: `git branch -a`
207−- Look for other branches that might contain code
208− 
209−### Build Failures
210−- First verify package.json exists: `ls package.json`
211−- Clear dependencies and reinstall: `rm -rf node_modules package-lock.json && npm install`
212−- Check Node.js version compatibility in package.json
213− 
214−### Development Server Issues
215−- Verify port availability (typically 3000 for Next.js)
216−- Check for environment variable requirements
217−- Review console output for specific error messages
218− 
219−## Critical Reminders
220− 
221−- **NEVER CANCEL builds or long-running commands** - they may take 45+ minutes
222−- **ALWAYS validate commands work** before assuming functionality exists
223−- **CHECK for package.json** before running npm commands
224−- **SET APPROPRIATE TIMEOUTS** - builds: 60+ minutes, tests: 30+ minutes
225−- **VERIFY repository state** before attempting any operations
71+### 4. Configuration Management
72+- Keep all configuration files in the project root
73+- Use TypeScript for configuration files when possible
74+- Document configuration options and their purposes
RuleStack

Built by

Kynth Studio

Directory

Configs
Stacks
Compare formats
Diff two configs
Best AGENTS.md examples

Formats

AGENTS.md
CLAUDE.md
Cursor rules
Copilot instructions

Reference

Read API
Corpus health
Privacy Policy
Terms

RuleStack

RuleStack

Built by

Kynth Studio

Directory

Configs
Stacks
Compare formats
Diff two configs
Best AGENTS.md examples

Formats

AGENTS.md
CLAUDE.md
Cursor rules
Copilot instructions

Reference

Read API
Corpus health
Privacy Policy
Terms

RuleStack

RuleStack

Built by

Kynth Studio

Directory

Configs
Stacks
Compare formats
Diff two configs
Best AGENTS.md examples

Formats

AGENTS.md
CLAUDE.md
Cursor rules
Copilot instructions

Reference

Read API
Corpus health
Privacy Policy
Terms

RuleStack