Skip to content

docs: Fix bug_report.md issue template to support product bugs, not only CI #74

@YaronZaki

Description

@YaronZaki

Problem Statement

.github/ISSUE_TEMPLATE/bug_report.md asks "Which CI workflow is affected?" and is titled "Report a bug to help us improve the CI/CD pipeline". The template assumes all bugs are CI-related, not product bugs. Product bug reports get mis-filed or users abandon reporting.

Evidence

# .github/ISSUE_TEMPLATE/bug_report.md
name: Bug report
about: Report a bug to help us improve the CI/CD pipeline
title: '[BUG] '

**CI Workflow**
Which workflow is affected: `CI`, `CD`, `Frontend Tests`, `Pylint`, `Integration Tests`

Impact

Low — contributor experience. Product bugs (position creation fails, UI glitch, incorrect calculation) don't fit the CI-focused template. Users may abandon bug reporting or file issues with incomplete information.

Proposed Solution

Update bug_report.md to cover both product bugs and CI issues. Add sections: Steps to Reproduce, Expected Behavior, Actual Behavior, Environment (Browser, Wallet, Network), Screenshots. Make CI section optional with a note that it's for pipeline issues only.

Acceptance Criteria

  • Template updated to cover product bugs and CI issues
  • Sections added: Steps to Reproduce, Expected Behavior, Actual Behavior, Environment
  • CI-specific section made optional or clearly marked for pipeline issues only
  • Template title/description no longer CI-specific

File Map

  • .github/ISSUE_TEMPLATE/bug_report.md — update template

Testing Strategy

  • Manual: Open a test bug report, verify template covers product bugs adequately.

Security Considerations

No security impact.

Definition of Done

  • Template updated and committed
  • PR linked and merged

Getting Started

Suggested first steps: (1) Read current bug_report.md, (2) Review GitHub's default bug report template for reference, (3) Add product-focused sections while keeping CI section optional.
Estimated time: 0.5 hours


Labels: open-source, good-first-issue
Priority: Low
Difficulty: Beginner
Estimated Effort: 0.5h

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions