Skip to content

Enhance bug report template with jcommons-specific fields (Java 17, CXF 4.0, coverage) #191

@sfloess

Description

@sfloess

Problem

Current bug_report.yml template is generic. For jcommons as a foundation library, we need more specific fields to ensure quality bug reports.

Proposed Enhancements

Add Required Environment Fields

  • jcommons Version/Tag: v1.30, v1.31, or main branch
  • Java Version: Must be 17+ (project requirement)
  • Apache CXF Version: Must be 4.0+ (project requirement)
  • Apache Commons Lang3 Version: Target 3.17+
  • Operating System: Platform details

Add Serialization-Specific Section

For issues involving serialization:

  • Request ObjectInputFilter logs (introduced v1.30)
  • Check for REJECTED path logs
  • Critical for Solenopsis session management debugging

Add Test Case Requirement

Rationale: jcommons maintains 93% line coverage standard

  • Require minimal failing test case
  • Link to branch/PR with reproduction
  • Issues without tests may be closed as incomplete

Update Labels

  • Current: bug, triage
  • Proposed: bug, triage, needs-reproduction (if no test)

Template Location

.github/ISSUE_TEMPLATE/bug_report.yml (currently exists)
OR .github/ISSUE_TEMPLATE/bug_report.md (new markdown version)

Benefits

  • Better quality bug reports
  • Faster triage (environment pre-validated)
  • Maintains coverage standard
  • Solenopsis-specific context captured

Implementation

  1. Update existing bug_report.yml with new fields
  2. Add validation for required fields
  3. Update CONTRIBUTING.md to reference template
  4. Consider markdown version for flexibility

Related

  • Part of v2.0 migration preparation
  • Aligns with 93% coverage requirement
  • Supports Solenopsis ecosystem

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    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