| Dimension | Shared | Only in A | Only in B | Overlap |
|---|---|---|---|---|
| Sections | 0 | 14 | 10 | 0% |
| Commands | 0 | 3 | 0 | 0% |
| Section tags | 0 | 7 | 2 | 0% |
What each file covers
Sections
0 shared · 14 only in A · 10 only in B- − Development Guidelines
- − Technology Stack
- − When Source Code is Added
- − Always verify package.json exists first
- − Install dependencies with appropriate timeout
- − Build with extended timeout for AI projects
- − Run tests with adequate time
- − Build with reasonable timeout for most projects
- − AI Integration Best Practices
- − Preferred AI Dependencies
- − Code Organization
- − Error Handling Pattern
- − File Structure Standards
- − Development Workflow
- + Documentation Requirements
- + Documentation Standards
- + Update Requirements
- + AI Service Documentation
- + OpenAI Integration
- + Common Errors
- + Code Documentation
- + Changelog Maintenance
- + Architecture Decision Records (ADRs)
- + Team Knowledge Sharing
Commands
0 shared · 3 only in A · 0 only in B- − npm install
- − npm run build
- − npm test
Section tags
0 shared · 7 only in A · 2 only in B- − setup
- − build
- − test
- − code-style
- − architecture
- − dependencies
- − agent-behaviour
- + security
- + docs
Line diff
HerringtonDarkholme/megarepo · .clinerules/02-development.md
@@ −1 @@
1# Development Guidelines
2
3## Technology Stack
4This repository is pre-configured for **Node.js/Next.js development** with AI integrations.
5
6### When Source Code is Added
7Follow these patterns based on existing repository guidelines:
8
9```bash
10# Always verify package.json exists first
11test -f package.json && echo "Node.js project detected" || echo "No package.json found"
12
13# Install dependencies with appropriate timeout
14npm install # Allow 10+ minutes for completion
15
16# Build with extended timeout for AI projects
17npm run build # Allow 60+ minutes - AI projects can have complex builds
18
19# Run tests with adequate time
20npm test # Allow 30+ minutes for comprehensive test suites
21```
22# Build with reasonable timeout for most projects
23npm run build # Allow 15-30 minutes for most Node.js/Next.js builds with AI integrations
24
25# Run tests with adequate time
26npm test # Allow 30+ minutes for comprehensive test suites
27## AI Integration Best Practices
28
29### Preferred AI Dependencies
30When adding AI functionality, use these established packages:
31- `openai` - Official OpenAI API client
32- `@langchain/core` - LangChain framework for AI workflows
33- `@vercel/ai` - Vercel AI SDK for streaming and UI integration
34- `@huggingface/inference` - Hugging Face API client
35- `@anthropic-ai/sdk` - Anthropic Claude API client
36
37### Code Organization
38- Place AI client configurations in `src/lib/` directory
39- Create reusable AI components in `src/components/ai/`
40- Implement API routes for AI services in `src/app/api/` (Next.js App Router)
41- Define TypeScript types for AI responses in `src/types/`
42
43### Error Handling Pattern
44```javascript
45// Implement comprehensive error handling for AI services
46try {
47 const response = await aiClient.chat.completions.create({
48 model: "gpt-4",
49 messages: [{ role: "user", content: prompt }]
50 });
51 return response.choices[0].message.content;
52} catch (error) {
53 if (error.code === 'rate_limit_exceeded') {
54 throw new AIRateLimitError('Rate limit exceeded, please try again later');
55 }
56 if (error.code === 'insufficient_quota') {
57 throw new AIQuotaError('API quota exceeded');
58 }
59 throw new AIServiceError(`AI service failed: ${error.message}`);
60}
61```
62
63## File Structure Standards
64Follow the established minimal structure and expand thoughtfully:
65
66```
67.
68├── .clinerules/ # Cline AI rules (this directory)
69├── .github/ # GitHub workflows and Copilot instructions
70├── .kiro/steering/ # Kiro AI steering files
71├── .cursorrules # Cursor AI development rules
72├── CLAUDE.md # Claude AI specific configuration
73├── GEMINI.md # Gemini CLI configuration
74├── AGENT.md # Universal AI agent instructions
75├── package.json # Dependencies and scripts (when added)
76├── src/ # Source code (when added)
77│ ├── lib/ # AI clients and utilities
78│ ├── components/ # React components including AI components
79│ ├── app/ # Next.js App Router (pages and API routes)
80│ └── types/ # TypeScript definitions
81└── public/ # Static assets
82```
83
84## Development Workflow
851. **Before Changes**: Check repository state and existing patterns
862. **During Development**: Follow TypeScript best practices and AI patterns
873. **Testing**: Include AI service mocks and error scenario testing
884. **Documentation**: Update relevant AI configuration files as needed
HerringtonDarkholme/megarepo · .clinerules/03-documentation.md
@@ +1 @@
1# Documentation Requirements
2
3## Documentation Standards
4Maintain comprehensive documentation that supports both developers and AI assistants working on this project.
5
6### Update Requirements
7- **README.md**: Update when adding significant functionality or changing project scope
8- **AI Configuration Files**: Keep all AI assistant configuration files current as project evolves
9- **Environment Documentation**: Maintain `.env.example` with all required variables documented
10- **API Documentation**: Document all AI service integrations and expected responses
11
12### AI Service Documentation
13When integrating AI services, document:
14
15#### Service Configuration
16```markdown
17## OpenAI Integration
18- **Model**: GPT-4 (configurable via environment)
19- **Rate Limits**: 500 requests/hour per API key
20- **Required Environment Variables**:
21 - `OPENAI_API_KEY`: Your OpenAI API key
22 - `OPENAI_MODEL`: Model to use (default: gpt-4)
23 - `OPENAI_MAX_TOKENS`: Maximum tokens per request (default: 2048)
24```
25
26#### Usage Examples
27Always include practical examples:
28```javascript
29// Example: Basic AI chat completion
30const completion = await openai.chat.completions.create({
31 model: process.env.OPENAI_MODEL || "gpt-4",
32 messages: [
33 { role: "system", content: "You are a helpful AI assistant." },
34 { role: "user", content: userPrompt }
35 ],
36 max_tokens: parseInt(process.env.OPENAI_MAX_TOKENS) || 2048
37});
38```
39
40#### Error Scenarios
41Document common error patterns and handling:
42```markdown
43### Common Errors
44- **401 Unauthorized**: Invalid API key or expired credentials
45- **429 Rate Limited**: Too many requests, implement exponential backoff
46- **500 Server Error**: AI service temporarily unavailable
47- **Context Length Exceeded**: Input too long for model context window
48```
49
50## Code Documentation
51- Use JSDoc comments for complex AI algorithms and integrations
52- Document function parameters and return types for AI service calls
53- Include examples in code comments for non-obvious AI implementations
54- Explain AI model choice rationale and configuration decisions
55
56## Changelog Maintenance
57When adding AI functionality, update documentation with:
58- New AI service integrations
59- Model version changes or updates
60- API endpoint modifications
61- Breaking changes to AI interfaces
62- Performance improvements or optimizations
63
64## Architecture Decision Records (ADRs)
65For major AI-related decisions, create ADRs documenting:
66- Why specific AI models or services were chosen
67- Trade-offs between different AI providers
68- Performance and cost considerations
69- Security and privacy implications
70
71## Team Knowledge Sharing
72- Document AI service setup steps for new team members
73- Include troubleshooting guides for common AI service issues
74- Maintain examples of successful AI integration patterns
75- Share lessons learned from AI service limitations and workarounds
@@ −1 +1 @@
1−# Development Guidelines
1+# Documentation Requirements
22
3−## Technology Stack
4−This repository is pre-configured for **Node.js/Next.js development** with AI integrations.
3+## Documentation Standards
4+Maintain comprehensive documentation that supports both developers and AI assistants working on this project.
55
6−### When Source Code is Added
7−Follow these patterns based on existing repository guidelines:
6+### Update Requirements
7+- **README.md**: Update when adding significant functionality or changing project scope
8+- **AI Configuration Files**: Keep all AI assistant configuration files current as project evolves
9+- **Environment Documentation**: Maintain `.env.example` with all required variables documented
10+- **API Documentation**: Document all AI service integrations and expected responses
811
9−```bash
10−# Always verify package.json exists first
11−test -f package.json && echo "Node.js project detected" || echo "No package.json found"
12+### AI Service Documentation
13+When integrating AI services, document:
1214
13−# Install dependencies with appropriate timeout
14−npm install # Allow 10+ minutes for completion
15−
16−# Build with extended timeout for AI projects
17−npm run build # Allow 60+ minutes - AI projects can have complex builds
18−
19−# Run tests with adequate time
20−npm test # Allow 30+ minutes for comprehensive test suites
15+#### Service Configuration
16+```markdown
17+## OpenAI Integration
18+- **Model**: GPT-4 (configurable via environment)
19+- **Rate Limits**: 500 requests/hour per API key
20+- **Required Environment Variables**:
21+ - `OPENAI_API_KEY`: Your OpenAI API key
22+ - `OPENAI_MODEL`: Model to use (default: gpt-4)
23+ - `OPENAI_MAX_TOKENS`: Maximum tokens per request (default: 2048)
2124 ```
22−# Build with reasonable timeout for most projects
23−npm run build # Allow 15-30 minutes for most Node.js/Next.js builds with AI integrations
2425
25−# Run tests with adequate time
26−npm test # Allow 30+ minutes for comprehensive test suites
27−## AI Integration Best Practices
28−
29−### Preferred AI Dependencies
30−When adding AI functionality, use these established packages:
31−- `openai` - Official OpenAI API client
32−- `@langchain/core` - LangChain framework for AI workflows
33−- `@vercel/ai` - Vercel AI SDK for streaming and UI integration
34−- `@huggingface/inference` - Hugging Face API client
35−- `@anthropic-ai/sdk` - Anthropic Claude API client
36−
37−### Code Organization
38−- Place AI client configurations in `src/lib/` directory
39−- Create reusable AI components in `src/components/ai/`
40−- Implement API routes for AI services in `src/app/api/` (Next.js App Router)
41−- Define TypeScript types for AI responses in `src/types/`
42−
43−### Error Handling Pattern
26+#### Usage Examples
27+Always include practical examples:
4428 ```javascript
45−// Implement comprehensive error handling for AI services
46−try {
47− const response = await aiClient.chat.completions.create({
48− model: "gpt-4",
49− messages: [{ role: "user", content: prompt }]
50− });
51− return response.choices[0].message.content;
52−} catch (error) {
53− if (error.code === 'rate_limit_exceeded') {
54− throw new AIRateLimitError('Rate limit exceeded, please try again later');
55− }
56− if (error.code === 'insufficient_quota') {
57− throw new AIQuotaError('API quota exceeded');
58− }
59− throw new AIServiceError(`AI service failed: ${error.message}`);
60−}
29+// Example: Basic AI chat completion
30+const completion = await openai.chat.completions.create({
31+ model: process.env.OPENAI_MODEL || "gpt-4",
32+ messages: [
33+ { role: "system", content: "You are a helpful AI assistant." },
34+ { role: "user", content: userPrompt }
35+ ],
36+ max_tokens: parseInt(process.env.OPENAI_MAX_TOKENS) || 2048
37+});
6138 ```
6239
63−## File Structure Standards
64−Follow the established minimal structure and expand thoughtfully:
65−
40+#### Error Scenarios
41+Document common error patterns and handling:
42+```markdown
43+### Common Errors
44+- **401 Unauthorized**: Invalid API key or expired credentials
45+- **429 Rate Limited**: Too many requests, implement exponential backoff
46+- **500 Server Error**: AI service temporarily unavailable
47+- **Context Length Exceeded**: Input too long for model context window
6648 ```
67−.
68−├── .clinerules/ # Cline AI rules (this directory)
69−├── .github/ # GitHub workflows and Copilot instructions
70−├── .kiro/steering/ # Kiro AI steering files
71−├── .cursorrules # Cursor AI development rules
72−├── CLAUDE.md # Claude AI specific configuration
73−├── GEMINI.md # Gemini CLI configuration
74−├── AGENT.md # Universal AI agent instructions
75−├── package.json # Dependencies and scripts (when added)
76−├── src/ # Source code (when added)
77−│ ├── lib/ # AI clients and utilities
78−│ ├── components/ # React components including AI components
79−│ ├── app/ # Next.js App Router (pages and API routes)
80−│ └── types/ # TypeScript definitions
81−└── public/ # Static assets
82−```
8349
84−## Development Workflow
85−1. **Before Changes**: Check repository state and existing patterns
86−2. **During Development**: Follow TypeScript best practices and AI patterns
87−3. **Testing**: Include AI service mocks and error scenario testing
88−4. **Documentation**: Update relevant AI configuration files as needed
50+## Code Documentation
51+- Use JSDoc comments for complex AI algorithms and integrations
52+- Document function parameters and return types for AI service calls
53+- Include examples in code comments for non-obvious AI implementations
54+- Explain AI model choice rationale and configuration decisions
55+
56+## Changelog Maintenance
57+When adding AI functionality, update documentation with:
58+- New AI service integrations
59+- Model version changes or updates
60+- API endpoint modifications
61+- Breaking changes to AI interfaces
62+- Performance improvements or optimizations
63+
64+## Architecture Decision Records (ADRs)
65+For major AI-related decisions, create ADRs documenting:
66+- Why specific AI models or services were chosen
67+- Trade-offs between different AI providers
68+- Performance and cost considerations
69+- Security and privacy implications
70+
71+## Team Knowledge Sharing
72+- Document AI service setup steps for new team members
73+- Include troubleshooting guides for common AI service issues
74+- Maintain examples of successful AI integration patterns
75+- Share lessons learned from AI service limitations and workarounds
