@julianoczkowski/my-rules
Version:
Personal development rules, guidelines, and documentation for coding projects
121 lines (92 loc) โข 5.37 kB
Markdown
# USER RULES - COMPLETE SET
Rule 1: Mandatory Todo List Creation & Task Management
CRITICAL: Always create a comprehensive todo list using the todo_write tool before starting ANY development task.
Requirements:
- BEFORE any development work: Create detailed todo list using `todo_write` tool
- Break down complex tasks into specific, actionable items
- Update status in real-time as you work (mark in_progress/completed)
- Focus on one task at a time - Mark only one todo as "in_progress" at any given moment
- Never skip this step - todo lists are mandatory for all development tasks
Every Task Must Follow:
1. ๐ CREATE TODO LIST (using todo_write tool) - NEVER SKIP
2. ๐ CREATE IMPLEMENTATION GUIDE (for major features) - Place in /implementation_guides folder
3. ๐ฏ ANALYZE requirements against project standards
4. ๐ป IMPLEMENT using established patterns and best practices
5. ๐ REVIEW code for quality and consistency
6. โ
MARK TODOS COMPLETE when finished
Rule 2: Implementation Guide Creation for Major Features
CRITICAL: Always create a comprehensive implementation guide before starting ANY major feature development.
Requirements:
- BEFORE major feature work: Create detailed implementation guide in `/implementation_guides` folder
- Always analyze available app architecture and existing patterns
- Create markdown files with clear structure and documentation
- Save the plan in `/implementation_guides` folder with descriptive filename
- Breakdown the implementation in phases (do not assign time of completion)
- Include mermaid graphs where applicable for visual clarity
- Add user stories starting with "As a user..." for feature context
Implementation Guide Must Include:
1. ๐ FEATURE OVERVIEW - Clear description and objectives
2. ๐๏ธ ARCHITECTURE ANALYSIS - Current app structure and integration points
3. ๐ MERMAID DIAGRAMS - Visual representation of data flow and components
4. ๐ฅ USER STORIES - Feature requirements from user perspective
5. ๐ฏ PERSONA MAPPING - Target users and use cases
6. ๐ IMPLEMENTATION PHASES - Step-by-step breakdown without timelines
7. ๐งช TESTING STRATEGY - How to validate the implementation
Rule 3: Communication & Progress Tracking
Communication Style:
- Be concise and focused - avoid unnecessary repetition
- Proactively explain decisions that affect architecture or approach
- Ask clarifying questions when requirements are unclear
- Provide progress updates by updating todo status visibly
Progress Transparency:
- Update todo status in real-time - Keep track of progress visibly
- Explain architectural decisions clearly
- Ask for clarification when requirements are unclear
- Maintain concise and focused communication
Rule 4: Development Standards & Code Quality
Code Organization:
- Follow project's file and directory structure conventions
- Use consistent naming patterns across the codebase
- Implement proper error handling and edge case management
- Write self-documenting code with clear interfaces
Development Practices:
- Follow project patterns - Use established conventions and component libraries consistently
- Use project templates and established patterns
- Leverage project's component library or design system
- Reference project's styling and theming systems
- Maintain consistency with project's iconography and asset standards
Rule 5: Project Consistency & Pattern Following
Universal Development Patterns:
- Always reference project technical standards before starting work
- Use established component templates and patterns for consistency
- Follow project styling conventions and design system
- Maintain consistency with project's established practices
- Prioritize code quality and maintainability in all implementations
Pattern Consistency:
- Leverage project conventions and established practices effectively
- Use project's established component patterns
- Maintains consistency with project conventions
- Follow established patterns and standards for consistency
Rule 6: Quality Assurance & Completion Standards
Before Completing Any Task:
- [ ] Todo list created and all items marked complete
- [ ] Code follows project technical standards
- [ ] Uses project's established component patterns
- [ ] Maintains consistency with project conventions
- [ ] Personal satisfaction with code quality and clarity
Quality Assurance Checklist:
- [ ] Test implementations thoroughly before completion
- [ ] Ensure accessibility standards are met when applicable
- [ ] Optimize for performance using project-appropriate techniques
- [ ] Document complex logic and architectural decisions
- [ ] Explained architectural decisions clearly
- [ ] Asked for clarification when requirements were unclear
- [ ] Provided progress updates through todo status
- [ ] Maintained concise and focused communication
Core Principles Summary:
1. Systematic Approach: Always use todo lists to break down complex tasks into manageable steps
2. Strategic Planning: Create implementation guides for major features before development begins
3. Quality First: Follow established patterns and standards for consistency
4. Clear Communication: Explain decisions and ask questions when needed
5. Pattern Consistency: Leverage project conventions and established practices effectively
6. Progress Transparency: Keep todo lists updated so progress is always visible