Skip to main content

Feature Request: GitHub Submission for FR, BR, and UXR

Type: Feature Request (FR)
Submitted: 2025-12-09
Submitted By: User
Priority: MEDIUM
Status: ACCEPTED - IMPLEMENTED

Summary​

Enable evaluation methods to submit Bug Reports (BR), Feature Requests (FR), or User Experience Research reports (UXR) via GitHub (e.g., GitHub Issues, GitHub Discussions, or custom GitHub integration).

Description​

What functionality is desired? Create a mechanism for external contributors, users, or evaluation methods to submit Bug Reports (BR), Feature Requests (FR), or User Experience Research reports (UXR) directly through GitHub, rather than requiring manual creation of FR/BR documents in the repository.

What problem does this solve?

  • Accessibility: Makes it easier for external contributors to submit feedback without needing repository access or knowledge of the Kanban framework structure
  • Automation: Enables automated evaluation methods (e.g., AI agents, testing frameworks) to submit reports programmatically
  • Integration: Leverages GitHub's native issue tracking and discussion features
  • Workflow: Streamlines the intake process by accepting submissions through familiar GitHub interfaces

What is the use case?

  1. External Contributors: Users who want to report bugs or request features but don't have repository write access
  2. Automated Evaluation: Testing frameworks or AI agents that need to programmatically submit bug reports or feature requests
  3. User Experience Research: UX researchers who want to submit research findings or usability reports
  4. Community Feedback: Community members who prefer GitHub Issues/Discussions over direct repository contributions

Who would benefit from this feature?

  • External contributors and users
  • Automated testing and evaluation systems
  • UX researchers and designers
  • Community members
  • Project maintainers (streamlined intake process)

Requirements​

Functional Requirements​

  • Support GitHub Issues as submission channel for BR, FR, and UXR
  • Support GitHub Discussions as alternative submission channel (optional)
  • Automatic conversion from GitHub Issue/Discussion to FR/BR/UXR document
  • Template-based issue forms for structured submissions (GitHub Issue Forms)
  • Labeling system to categorize submissions (bug, feature, ux-research)
  • Integration with existing FR/BR intake workflow (FR/BR → Task → Story → Epic)
  • Automatic creation of FR/BR/UXR documents from GitHub submissions
  • Bidirectional linking between GitHub Issues and FR/BR documents

Non-Functional Requirements​

  • Performance: Conversion process should complete within reasonable time (< 30 seconds)
  • Security: Validate and sanitize user input from GitHub submissions
  • Usability: Clear templates and instructions for GitHub submission
  • Compatibility: Work with GitHub Issues, GitHub Discussions, and GitHub Issue Forms
  • Reliability: Handle edge cases (malformed submissions, missing fields, etc.)

Scope Analysis​

Problem Domain: FR/BR Intake, GitHub Integration, Automation
Affected Areas:

  • Backend/API
  • Frontend/UI
  • Database/Schema
  • Documentation
  • Testing
  • Other: GitHub Actions, Issue Templates, Automation Scripts

Estimated Complexity:

  • Simple (1-3 days)
  • Medium (1 week)
  • Complex (2+ weeks)
  • Very Complex (1+ month)

Use Cases​

Primary Use Case: An external contributor discovers a bug and wants to report it. They create a GitHub Issue using the bug report template. The system automatically converts the GitHub Issue into a BR document, creates the associated Kanban task, and links the Issue to the BR document.

Additional Use Cases:

  1. Automated Testing: A CI/CD pipeline runs automated tests and creates GitHub Issues for failed tests. These are automatically converted to BR documents.
  2. UX Research Submission: A UX researcher completes a usability study and submits findings via GitHub Discussion. The system converts it to a UXR document.
  3. Feature Request from Community: A community member suggests a feature via GitHub Issue. The system converts it to an FR document and routes it through the intake workflow.
  4. Bulk Import: Historical GitHub Issues are batch-converted to FR/BR documents for migration purposes.

Acceptance Criteria​

  • GitHub Issue templates created for BR, FR, and UXR submissions ✅
  • GitHub Action or script that converts GitHub Issues to FR/BR/UXR documents ✅
  • Automatic creation of Kanban tasks from GitHub submissions ✅ (via intake workflow)
  • Bidirectional linking between GitHub Issues and FR/BR documents ✅
  • Integration with existing FR/BR intake workflow (Epic/Story assignment) ✅
  • Documentation for external contributors on how to submit via GitHub ✅
  • Validation and error handling for malformed submissions ✅ (basic validation in workflow)
  • Support for GitHub Issue Forms (structured templates) ✅

Dependencies​

Blocks:

  • None

Blocked By:

  • None

Related Work:

  • Epic 4 Story 2: FR/BR Intake to Tasks (foundation for intake workflow)
  • Epic 4 Story 5: Canonical Epics for Kanban Framework (Epic 5: FR Implementation, Epic 6: BR Implementation)
  • Epic 2: Workflow Management Framework (potential automation workflows)

Intake Decision​

Intake Status: ACCEPTED
Intake Date: 2025-12-09
Intake By: AI Assistant

Decision Flow Results:

  • Story Match Found: Epic 4, Story 2 → Task 6 (new task)

Assigned To:

  • Epic: Epic 4 - Kanban Framework
  • Story: Story 2 - FR/BR Intake to Tasks
  • Task: E4:S02:T06 - GitHub submission integration for FR, BR, and UXR
  • Version: 0.4.2.6+1

Kanban Links:

Notes​

  • UXR Acronym: Using "UXR" (User Experience Research) as the standard acronym for UX reports, which is commonly used in the industry

  • GitHub Integration Options:

    • GitHub Issues (primary)
    • GitHub Discussions (alternative for community discussions)
    • GitHub Issue Forms (structured templates)

  • Automation Approach: Could use GitHub Actions, webhooks, or scheduled scripts to convert Issues to FR/BR documents

  • Template Alignment: GitHub Issue templates should align with existing FR/BR templates in the Kanban framework

  • Future Enhancement: Could extend to other platforms (GitLab, Jira, etc.) if needed

References​

  • packages/frameworks/kanban/templates/FR_TEMPLATE.md - Feature Request template
  • packages/frameworks/kanban/templates/BR_TEMPLATE.md - Bug Report template
  • docs/project-management/kanban/epics/Epic-4/Story-002-fr-br-intake-to-tasks.md - FR/BR intake workflow
  • GitHub Issue Forms - GitHub's structured issue templates
  • GitHub Discussions - GitHub Discussions feature

Template Usage:

  • This FR follows the Kanban Framework FR template
  • Intake decision links to Epic 4, Story 2, Task 6
  • Implementation will follow the FR/BR intake workflow

This template is part of the Kanban Framework. See packages/frameworks/kanban/ for complete framework documentation.