We believe in the power of collaboration! Any input, suggestions, or contributions are highly welcome to make this project even better. Feel free to open issues, submit pull requests, or simply share your ideas. Together, we can enhance our AI coding workflows!
This repository provides tips, tricks, and snippets to help you effectively use AI-powered coding tools in your projects. By following the provided examples and guidelines, you can significantly improve the quality and productivity of your AI coding workflows.
Work is progressing on v2.0 - expected before end of month.
- How to Use These Tools
- Example Output
- Suggested Workflow Rotation
- Tips for Productivity
- Tested AI Tools
➝ Workflow Overview (workflow.md)
-
1⃣ Start with Your Idea
Write your project description as a markdown file (e.g., idea.md). -
2⃣ Generate a Project Plan
Use the following prompts to transform your project description into a detailed project plan:- Create Plan Prompt: create-plan.md
- Guidelines Prompt: guidelines.md
- Combine the two prompts above with your idea prompt idea.md.
- Example "Full Create Plan Prompt": full-create-plan-prompt.md
- Example output from o1-mini: Plan.md
-
3⃣ Iterative Development
Utilize the provided prompts and tools to iteratively refine your codebase and address issues:- Next Story Prompt: next-story.md
- Fix Resume Prompt: fix-resume.md
- Post-Mortem Prompt: post-mortem.md
-
4⃣ Unit Testing and Codebase Maintenance
For comprehensive testing, run the full codebase evaluation prompt:- Fix Codebase Prompt: fix-codebase.md
-
5⃣ Tagging for Rollback
After completing each story, tag your Git commit for easy versioning.- Example: After finishing story 1.1, tag the commit as
v0.1.1
. - For rollbacks, revert to the desired tag, uncheck relevant story tasks, and adjust lessons learned in the post-mortem.
- Example: After finishing story 1.1, tag the commit as
Here’s an example of a generated project plan:
# Project Plan for AI Supervisor App
## Epics
- [ ] **User Authentication**
- *Implement secure user authentication and role-based access control using Keycloak.*
- [ ] *Set up Keycloak Docker container.*
- **Description**: Deploy Keycloak using Docker for authentication services.
- **Testing Focus**: Verify Keycloak container starts correctly and is accessible.
- [ ] *Configure Keycloak realms and clients.*
- **Description**: Set up necessary realms and clients in Keycloak.
- **Testing Focus**: Ensure realms and clients are correctly configured and functional.
To complete a project efficiently:
- New Cascade: If using Windsurf, start a new cascade before you run the next story prompt.
- Next Story Prompt: Start with the current development task.
- Fix Resume Prompt: Iterate to refine and fix issues until all unit tests pass.
- Post-Mortem Prompt: Capture lessons learned and prepare for the next story.
💡 Tip: Use version tags to manage your project versions effectively.
- 🏷️ Versioning: Tag each completed story for easy rollback and historical reference.
- ✅ Testing: Regularly run the fix-codebase.md to ensure the entire codebase remains stable and pass all tests.
- 🤝 Collaboration: Share the project plan and outputs with your team for transparency and alignment.
This toolkit has been tested with several AI-powered development tools, ensuring compatibility and optimizing workflows. Here’s a list of AI tools we have tested, along with their respective links:
- Windsurf Editor - Windsurf Editor
- oTToDev - GitHub Link
- Cline - GitHub Link
- Bolt.new - Bolt.new
- Aide - Aide
- Kodu.ai - Kodu.ai
This repository serves as a complete toolkit for managing AI-driven software projects, helping you iterate quickly, maintain quality, and streamline your development process. Happy coding!