AI Assistant Guidelines for Bindra Development

🚫 File Creation Restrictions

NEVER Create These Automatically

❌ CHANGELOG.md
❌ UPDATES.md
❌ SUMMARY_OF_CHANGES.md
❌ IMPLEMENTATION_NOTES.md
❌ WORK_COMPLETED.md
❌ Any .md file documenting what you just did

✅ Only Create .md Files When

1. User explicitly requests: "Create a guide for..."
2. User asks: "Document X in a new markdown file"
3. Setting up a new feature that requires documentation
4. User says: "Write this in a separate document"

Instead, Provide

• Brief text summary in chat response
• Update existing documentation files
• Link to relevant docs/ files
• Inline code comments

📝 Documentation Updates

Update These Files (Don't Create New Ones)

• README.md - For API changes
• docs/guides/NEXT_STEPS.md - For action items
• docs/analysis/IMPROVEMENTS.md - For improvement suggestions
• docs/analysis/SUMMARY.md - For status updates

Format for Updates

Added: Brief description
Modified: What changed
Fixed: What was broken

💻 Code Modification Guidelines

Use Efficient Tools

• Use multi_replace_string_in_file for multiple edits
• Batch independent operations together
• Include 3-5 lines of context for replacements

After Making Changes

1. Verify TypeScript compiles: pnpm run build
2. Check for errors with get_errors tool
3. Provide brief summary in chat
4. DO NOT create a .md file to document changes

🎯 Project Priorities

Refer to: docs/guides/NEXT_STEPS.md

1. Make DataSource generic
2. Add error handling
3. Implement validation
4. Setup testing
5. Add production features

📚 Documentation Structure

docs/
├── README.md                 # Navigation hub
├── guides/                   # How-to guides
│   └── NEXT_STEPS.md        # Action plans
├── analysis/                 # Analysis docs
│   ├── IMPROVEMENTS.md      # Improvement guide
│   └── SUMMARY.md           # Project overview
└── guidelines/              # This folder
    └── AI_ASSISTANT_GUIDELINES.md

✨ Best Practices

Communication

• Be concise in responses
• Provide code examples inline
• Reference existing documentation
• Explain reasoning for decisions

Quality

• Write tests for new features
• Add JSDoc to public APIs
• Follow TypeScript strict mode
• Keep commits focused

Workflow

1. Understand the request
2. Check existing code/docs
3. Make necessary changes
4. Verify it works
5. Provide brief summary
6. Stop (no .md file creation)

🔍 Example Interactions

❌ Bad: Auto-Creating Documentation

User: "Add validation to DataSource"
AI: [makes changes] "I've created VALIDATION_IMPLEMENTATION.md to document..."

✅ Good: Brief Summary

User: "Add validation to DataSource"
AI: [makes changes] "Added validation system to DataSource with validateField 
and validateRecord methods. Updated README.md with usage examples."

✅ Good: When User Requests Doc

User: "Create a migration guide for v2.0"
AI: [creates docs/guides/MIGRATION_V2.md] "Created migration guide at..."

📌 Remember

The golden rule: Only create .md files when explicitly asked.

Users prefer:

• Quick text summaries
• Updated existing docs
• Working code
• Not: Extra files to manage