windsurf-rules-template.md•3.29 kB
# Windsurf IDE Rules Template
## Generated by MCP ADR Analysis Server
**Purpose**: Configure Windsurf IDE for optimal `{PROJECT_NAME}` development with AI-powered workflows.
## Project Configuration
- **Repository**: `{REPO_PATH}`
- **Primary Language**: `{PRIMARY_LANGUAGE}`
- **Framework**: `{FRAMEWORK}`
- **Team Size**: `{TEAM_SIZE}`
## AI Pair Programming Rules
### Context Awareness
```yaml
context_rules:
- always_include:
- current_file_imports
- related_test_files
- architectural_decisions
- exclude:
- sensitive_data_patterns
- api_keys_and_secrets
```
### Code Generation Preferences
```yaml
generation_rules:
style:
- follow_existing_patterns
- maintain_consistency
- respect_architecture_decisions
security:
- no_hardcoded_credentials
- validate_all_inputs
- use_secure_defaults
testing:
- generate_tests_first
- maintain_80_percent_coverage
- include_edge_cases
```
## Workflow Automations
### Development Workflows
```yaml
workflows:
feature_development:
steps:
- analyze_requirements
- suggest_architecture
- generate_tests
- implement_feature
- validate_compliance
bug_fixing:
steps:
- reproduce_issue
- analyze_root_cause
- suggest_fix
- validate_regression
- update_tests
```
### Code Review Assistant
```yaml
review_rules:
automated_checks:
- architecture_compliance
- security_vulnerabilities
- performance_implications
- test_coverage
suggestions:
- optimization_opportunities
- refactoring_candidates
- documentation_gaps
```
## Project-Specific Patterns
### Architecture Patterns
```yaml
patterns: { GENERATED_ARCHITECTURE_PATTERNS }
```
### Error Handling
```yaml
error_handling: { GENERATED_ERROR_PATTERNS }
```
## Command Palette
### Quick Commands
- `Cmd+Shift+A` - Analyze current file architecture
- `Cmd+Shift+T` - Generate tests for current function
- `Cmd+Shift+D` - Check deployment readiness
- `Cmd+Shift+S` - Security scan current file
### AI Commands
- `/explain` - Explain current code block
- `/optimize` - Suggest optimizations
- `/refactor` - Propose refactoring
- `/document` - Generate documentation
## Integration Configuration
### MCP ADR Analysis Server
```json
{
"mcp_integration": {
"server": "mcp-adr-analysis-server",
"auto_sync": true,
"workflows": [
"analyze_project_ecosystem",
"suggest_adrs",
"validate_rules",
"generate_adr_todo"
]
}
}
```
### Tool Automation
```yaml
automation:
on_save:
- lint_fix
- format_code
- update_imports
on_commit:
- run_tests
- check_coverage
- validate_architecture
on_push:
- deployment_readiness_check
- security_scan
```
## Performance Optimizations
### Indexing Rules
```yaml
indexing:
include:
- source_code
- tests
- documentation
exclude:
- node_modules
- build_artifacts
- large_binaries
```
### AI Response Tuning
```yaml
ai_tuning:
response_time: fast
accuracy_level: high
context_depth: comprehensive
suggestion_frequency: moderate
```
## Custom Rules
Add your Windsurf-specific customizations:
```yaml
custom_rules:
# Your project-specific rules here
```