This project is configured for Spec-Driven Development using spec-kit and AI coding assistants. Follow these best practices for optimal results:
- Cursor with AI features
- Claude Code
- GitHub Copilot
- VS Code with AI extensions
Use the /specify command to define your project:
/specify "Build a [type] application that [main purpose]. Key features include [feature 1], [feature 2], and [feature 3]. The application should [performance/security requirements]."
Best Practices for Specifications:
- Be specific about the main purpose and target users
- Include key features and functionality requirements
- Mention performance, security, or scalability needs
- Specify the technology stack if you have preferences
- Include any design or UX requirements
Use the /plan command to develop implementation strategy:
/plan "The application will use [tech stack]. Architecture: [frontend/backend structure]. Database: [data storage solution]. Key components: [component 1], [component 2]. Development approach: [methodology]."
Best Practices for Planning:
- Choose appropriate technology stack
- Define clear architecture and component structure
- Plan data models and API design
- Consider scalability and maintainability
- Break down into manageable phases
Use the /tasks command to get actionable development items:
- Review the generated task list
- Prioritize tasks based on dependencies
- Estimate effort for each task
- Assign tasks or work through them systematically
Use the /implement command to build specific features:
/implement specs/001-feature-name/plan.md
Best Practices for Implementation:
- Work on one feature at a time
- Follow the generated specifications closely
- Test each feature before moving to the next
- Use version control effectively (you're already on develop branch!)
- Start with spec-kit commands - Define what you're building
- Use AI assistance - Let AI help with implementation details
- Test frequently - Ensure each feature works before proceeding
- Commit regularly - Use push_updates.bat to save progress
- Iterate and refine - Use /specify to update requirements as needed
- Double-click the file or run from command line
- Follow prompts for commit messages
- Automatic handling - Git add, commit, and push to develop branch
- No branch switching needed - You're already on develop!
- /specify "description" - Define project requirements
- /plan "strategy" - Create technical implementation plan
- /tasks - Generate actionable task list
- /implement specs/XXX-feature/plan.md - Implement specific features
mad-project2/ ├── .spec-kit/ # spec-kit configuration ├── specs/ # Project specifications ├── plans/ # Technical implementation plans ├── tasks/ # Task breakdowns ├── .spec-kit.json # spec-kit configuration file ├── push_updates.bat # Automated push script └── README.md # This file
- Provide clear, detailed specifications
- Include examples and edge cases
- Specify error handling requirements
- Mention testing and validation needs
- Start with high-level specifications
- Refine details as you learn more
- Update specifications based on implementation insights
- Use /specify to adjust requirements during development
- Ask for code reviews and improvements
- Request explanations for complex concepts
- Get help with debugging and optimization
- Use AI for documentation and comments
- Test each feature thoroughly
- Follow coding best practices
- Keep code clean and well-documented
- Use version control effectively
- Open this project in your AI coding environment
- Start with /specify - Define your project requirements
- Use /plan - Create your technical implementation strategy
- Run /tasks - Get your development roadmap
- Begin implementation - Use /implement for each feature
- Use push_updates.bat - Save your progress regularly
- Repository URL: https://github.com/richard1912/mad-project2.git
- Current Branch: develop (ready for development)
- Setup Date: 2025-09-15 13:02:24
Happy AI-driven development! 🚀🤖