Skip to main content

Story 005 – Bug Reports

Status: IN PROGRESS (Perpetual)
Priority: HIGH
Estimated Effort: [TBD]
Created: 2025-12-07
Last updated: 2026-01-16 (v0.6.5.2+1, migrated from v0.6.5.2+1 – Story renumbered from S04 to S05 as part of repository story migration)
Version: v0.6.5.2+1
Code: E6S05

Note: This story was renumbered from S04 to S05 as part of the repository story abstract space resolution (E9:S01:T08).

Story Type: Perpetual Maintenance
Completed: N/A (Perpetual story - never completes)
Explanation: This story represents ongoing bug tracking and resolution work. New bugs will create new tasks under this story. The story remains IN PROGRESS even when all current tasks are complete, as new bugs may be reported at any time.

Task Checklist​

  • E6:S05:T01 – Fix RW installer template path bug ✅ COMPLETE (v0.6.5.1+1) - Fixed incorrect path to cursorrules template file
  • E6:S05:T02 – Document canonical stories for Kanban framework ✅ COMPLETE (v0.6.5.2+1) - Created CANONICAL_STORIES.md documenting Bug Reports and Feature Requests patterns

Overview​

This story tracks all bug reports and bug fixes related to framework management, installation, updates, and maintenance. Bugs are converted into tasks following the FR/BR → Task → Story → Epic flow defined in the Kanban governance policy.

Perpetual Story: This is a perpetual maintenance story that never completes. New bug reports will create new tasks under this story. The story remains IN PROGRESS even when all current tasks are complete, as bug tracking is an ongoing activity.

Goal​

Systematically track, prioritize, and resolve bugs in framework packages, installation tools, update mechanisms, and related framework management processes.

Tasks​

E6:S05:T01 – Fix RW installer template path bug​

Input: User feedback from been-there project indicating installer script couldn't find template file
Deliverable: Fixed installer script with correct template path
Dependencies: None
Blocker: None

Problem Statement: The RW installer script (install_release_workflow.py) was looking for the cursorrules-rw-trigger-section.md template file in the wrong location. It was using PACKAGE_ROOT (which points to packages/frameworks/) instead of the framework root directory (packages/frameworks/workflow mgt/), causing a FileNotFoundError when users tried to run the installer.

Root Cause:

  • Script calculated: PACKAGE_ROOT = SCRIPT_DIR.parent.parent = packages/frameworks/
  • Template file is actually at: packages/frameworks/workflow mgt/cursorrules-rw-trigger-section.md
  • Script was looking for: packages/frameworks/cursorrules-rw-trigger-section.md (wrong path)

Solution:

  • Added FRAMEWORK_ROOT = SCRIPT_DIR.parent to correctly point to packages/frameworks/workflow mgt/
  • Updated CURSORRULES_TEMPLATE to use FRAMEWORK_ROOT instead of PACKAGE_ROOT
  • Updated SCHEMA_DOC to use FRAMEWORK_ROOT for consistency

Changes Made:

  • packages/frameworks/workflow mgt/scripts/install_release_workflow.py:
    • Added FRAMEWORK_ROOT = SCRIPT_DIR.parent
    • Changed CURSORRULES_TEMPLATE = PACKAGE_ROOT / "cursorrules-rw-trigger-section.md" to FRAMEWORK_ROOT / "cursorrules-rw-trigger-section.md"
    • Changed SCHEMA_DOC = PACKAGE_ROOT / "config" / "rw-config-schema.md" to FRAMEWORK_ROOT / "config" / "rw-config-schema.md"

Verification:

  • ✅ Template file exists at: packages/frameworks/workflow mgt/cursorrules-rw-trigger-section.md
  • ✅ Schema file exists at: packages/frameworks/workflow mgt/config/rw-config-schema.md
  • ✅ Path calculation now correctly resolves to framework root directory

Impact:

  • Before: Installer failed with FileNotFoundError when trying to load template
  • After: Installer successfully finds and loads template file
  • User Impact: Users can now run the installer without needing to manually work around the path bug

Related Work:

  • E05:S04:T08 - Document .cursorrules setup for RW trigger (documentation that references the installer)
  • E2:S04 - RW Installer & Plug-and-Play Adoption (original installer implementation)

E6:S05:T02 – Document canonical stories for Kanban framework​

Input: Bug Reports and Feature Requests stories created in Epic 6
Deliverable: Canonical stories documentation for Kanban framework
Dependencies: E6:S05:T01, E6:S05 (Feature Requests story)
Blocker: None

Status: ✅ COMPLETE

Problem Statement: No centralized documentation existed for reusable story patterns in the Kanban framework. Projects adopting the framework had no reference for common organizational patterns like Bug Reports and Feature Requests stories.

Solution: Created CANONICAL_STORIES.md document in the Kanban framework templates directory that:

  • Documents Bug Reports and Feature Requests as canonical story patterns
  • Provides usage instructions for adopting these patterns
  • Includes template references and example locations
  • Establishes process for adding new canonical stories

Changes Made:

  • packages/frameworks/kanban/templates/CANONICAL_STORIES.md:

    • Created new document listing canonical story patterns
    • Documented Bug Reports pattern (purpose, characteristics, template references, example location)
    • Documented Feature Requests pattern (purpose, characteristics, template references, example location)
    • Added usage instructions and guidelines for adding new patterns

  • packages/frameworks/kanban/README.md:

    • Added CANONICAL_STORIES.md to Package Contents section (templates)
    • Added CANONICAL_STORIES.md to Documentation section with description

Verification:

  • ✅ Canonical stories document created with Bug Reports and Feature Requests patterns
  • ✅ Document includes usage instructions and guidelines
  • ✅ README updated to reference canonical stories document
  • ✅ Document follows framework documentation standards
  • ✅ Template references point to existing FR/BR templates

Impact:

  • Before: Projects had to discover and implement common story patterns independently
  • After: Projects can reference canonical story patterns and adapt them to their needs
  • User Impact: Improves framework adoption by providing reusable patterns

Dependencies​

Blocks:

  • None

Blocked By:

  • None

Coordinates With:

  • Epic 5 (Documentation Management) - Bug fixes may require documentation updates
  • Epic 2 (Workflow Management Framework) - Bugs in workflow framework tools

References​

  • docs/project-management/kanban/epics/Epic-6/Epic-6.md
  • docs/project-management/rituals/policy/kanban-governance-policy.md - FR/BR → Task → Story → Epic flow