Skip to content

Diagnostic Package Generation for Issue Reporting #186

Description

@zhangt2333

Clear and concise description of the problem

Currently, when users encounter errors or unexpected behavior with our tool, they face several challenges for issue reporting:

  • Manually gathering all relevant information (configuration, input files, logs)
  • Uncertainty about what information is necessary for reproduction
  • Time-consuming process that discourages issue reporting
  • Users who modify the source code may have unique context that are hard to communicate

Suggested Solution

Implement a --diagnostic-package (or --diag) command-line option that automatically:

  1. Collects all relevant reproducible-related information
    • Files in Java classpath for collecting the Tai-e class files run by user
    • Files in Tai-e classpath for collecting the analyzed program provided by user
    • option.yml
    • tai-e.log
  2. Packages them into a ZIP file

So that:

  • Users can create reproducible case in seconds instead of minutes
  • Users who modify source code can easily share their exact code
  • We reduce back-and-forth communication asking for missing information
  • Issue quality improves, leading to faster resolution times

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    for: team-meetingAn issue we'd like to discuss as a team to make progresstype: enhancementA general enhancement

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions