AI Assistant Guide to GitHub Workflow

A comprehensive guide to the GitHub workflow and methodology for AI assistants

GitHub Workflow Purpose and Goals

Note: This guide is specifically designed for AI assistants, not human developers. It provides a structured reference for understanding and implementing the project's GitHub workflow methodology.

This GitHub workflow is designed to provide a structured, hierarchical approach to software development that maintains clear traceability from business requirements to implementation. It follows a domain-driven design approach with a 3-level hierarchy of issues.

Key Goals

  • Maintain clear traceability from business requirements to implementation
  • Organize work in a hierarchical structure for better management
  • Support parallel development with isolated feature branches
  • Ensure proper code review and quality control
  • Facilitate collaboration between humans and AI assistants

How to Use This Guide

When asked to implement features or fix bugs, refer to this guide to understand the proper workflow for creating branches, linking issues, and submitting pull requests. The workflow follows specific patterns that should be consistently applied to maintain the project's structure and traceability.

At the beginning of each session, the user will share this guide with you to ensure you understand the project's workflow methodology. You should use the PlantUML WBS tool to create a visual work breakdown structure for planning before implementing any features.