Neura Market
Back to .md Directory
PROMPTS.md

ToDo

Tracks development progress and known issues for a Zsh plugin that generates git commit suggestions via LLM providers.

ngattusohw
May 2, 2026
0 downloads
0 views
ai llm rag prompt openai
View source

What this file does

Tracks development progress and known issues for a Zsh plugin that generates git commit suggestions via LLM providers.

When to use it

  • You maintain a Zsh plugin or CLI tool and need a structured task tracker
  • You want to see which features are implemented vs planned in this git commit suggestion project
  • You are contributing to this repository and need to know what work remains

Assumes this stack

ZshOpenAIAnthropicLLM

ToDo

Known Issues

  • Job control messages (process IDs) are displayed when running background suggestion generation ✅ FIXED

Configuration Management

  • Implement persistent configuration storage (~/.git-suggest-config)
  • Add basic configuration validation
  • Improve configuration display to show both file and environment sources
  • Enhance configuration validation (API key formats, file permissions)
  • Support multiple configuration profiles
  • Add command to view current configuration
  • Add command to clear configuration
  • Add configuration backup/restore functionality
  • configuration should persist across multple shell instances -- bug where I am having to put my llm key in multiple times

LLM Integration

  • Create basic LLM provider structure
  • Complete LLM provider abstraction layer
  • Implement OpenAI provider (basic functionality)
  • Enhance OpenAI provider with better error handling
  • Implement Anthropic provider
  • Add initial local model support
  • Enhance local model support (model validation, format checking)
  • Add rate limiting and token usage tracking
  • Implement async operations to prevent shell blocking
  • Add provider-specific configuration validation

Prompt Engineering

  • Design base prompt template
  • Extract prompt logic into shared function for all providers
  • Allow for custom prompt templates
  • Add repository context to prompts (file types, repo name)
  • Implement diff size optimization (handle large changes)
  • Add diff preprocessing for better LLM understanding
  • Add template validation
  • Add prompt versioning and migration support

Error Handling

  • Implement basic state management
  • Add basic error messaging
  • Add basic API error handling
  • Improve error state persistence and display
  • Add Tab retry mechanism for loading states
  • Fix job control messages during background processing
  • Enhance API error handling (rate limits, network issues)
  • Implement token validation
  • Add graceful fallbacks for errors
  • Enhance error messaging with troubleshooting steps
  • Add error logging and reporting
  • Implement retry mechanisms for transient failures

User Experience & Onboarding

  • Add state-based feedback messages
  • Improve diff detection and caching
  • Fix loading state display issues
  • Add Tab retry mechanism for suggestions
  • Improve onboarding experience for new users
    • Add interactive setup wizard
    • Create guided first-run experience with welcome messages
    • Add smart defaults and recommendations
    • Add provider comparison with speed/cost information
  • Auto-detection and smart configuration
    • Auto-detect existing API keys in environment (OPENAI_API_KEY, ANTHROPIC_API_KEY)
    • Suggest optimal provider based on available keys
    • Validate API keys during setup with real API tests
  • User-friendly setup process
    • Simplify configuration flow with enhanced menu
    • Add setup validation with real API tests
    • Provide clear success/failure feedback
    • Add step-by-step guidance with helpful links
  • Documentation and examples
    • Add quick start guide in setup wizard
    • Include common setup examples in documentation
    • Show sample commit messages during setup
  • First-time user experience
    • Add welcome message and tips
    • Provide usage examples after setup
    • Add helpful hints for common workflows
  • Move suggestion generation to git add for better performance
  • Add progress indicators for long-running operations
  • Improve suggestion formatting
  • Add command to view suggestion history
  • Add ability to regenerate suggestions
  • Add debug logging
  • Add debug mode toggle for users
  • Add color configuration options
  • Add suggestion preview in status bar

Testing & Documentation

  • Add unit tests for core functionality
  • Add integration tests for LLM providers
  • Create comprehensive user documentation
    • Write detailed README with installation guide
    • Add setup and configuration documentation
    • Include troubleshooting section
    • Add FAQ for common issues
  • Installation and setup instructions
    • Add multiple installation methods
    • Include dependency requirements
    • Provide platform-specific instructions
  • Add configuration examples
  • Document prompt templates
  • Add troubleshooting guide
  • Create contribution guidelines
  • Add performance benchmarks
  • Document debug log format
  • Add examples of successful prompts and responses

Performance & Optimization

  • Basic diff caching mechanism
  • Optimize diff caching mechanism
  • Add suggestion caching
  • Implement lazy loading for providers
  • Add memory usage optimization
  • Improve startup time
  • Add background processing for suggestions

Security

  • Add basic token security (file permissions)
  • Add token encryption
  • Implement secure token storage
  • Add provider-specific security measures
  • Add security documentation
  • Add token rotation support

What's inside

8 sections covering known issues, configuration, LLM integration, prompt engineering, error handling, UX, testing, performance, and security

Change this for your project

  • Replace ~/.git-suggest-config with your own config path
  • Replace OPENAI_API_KEY and ANTHROPIC_API_KEY with your own environment variable names
  • Replace zsh-git-commit-suggestions with your own repository name

Where it goes

A prompt collection. Copy the individual prompts you need rather than the whole file.

Worth borrowing

  • Organizing a TODO list by feature area (e.g., LLM Integration, Error Handling) rather than by priority or date
  • Using nested checklists with sub-items for complex features (e.g., onboarding experience with multiple sub-tasks)

Related Documents

PROMPTS.md

starProject

Lists 120+ starred open-source projects across AI, DevOps, Flutter, and web development for discovery and inspiration.

aiagentllm
0
94
Mran
PROMPTS.md

midjourney-expert

Serves as a reference for Midjourney V7/Niji 7 prompting, covering parameters, reference systems, editing tools, and moderation workarounds.

aipromptmcp
0
26
Aedelon
PROMPTS.md

🎣 Hooks & Headlines Generator

Generates 20, 30 headline variations across 10 proven formulas, with psychological reasoning and platform-specific best practices.

aiprompt
0
24
vivmagarwal
PROMPTS.md

Daily Agent Tasks Framework

Gives you a daily structure for assigning strategic work to Claude and development work to Codex, organized by project priority and current sprint.

aiagentprompt
0
16
frankxai