Back to tips
    Rewrite Issue: Let AI Automatically Improve Your GitHub Issues

    Rewrite Issue: Let AI Automatically Improve Your GitHub Issues

    Introduction

    "What exactly is this issue asking for?"—Sound familiar?

    GitHub issues are the starting point of team development, but when they're vague or inconsistently written, they slow everyone down. Developers waste time deciphering intent, and miscommunication leads to wrong implementations. Issues created in a hurry or lacking context are a common source of friction.

    DevLoop Runner's Rewrite Issue feature solves this problem with AI. It analyzes an existing GitHub issue and automatically rewrites it into a clearer, more actionable description.

    What Is Rewrite Issue?

    Rewrite Issue is one of three modes available in DevLoop Runner's Issue Run feature.

    ModeDescription
    Create IssueAnalyzes a repository and creates new issues automatically
    Rewrite IssueRewrites an existing issue to improve clarity and structure
    Close IssueAutomatically closes stale or outdated issues

    While Create Issue finds problems in your codebase, Rewrite Issue polishes existing issues. The AI reads the issue content and transforms it into a well-structured, easy-to-understand description.

    For the other modes, see:

    What Issues Benefit from Rewriting?

    The following types of issues see the greatest improvement with Rewrite Issue.

    Vague Descriptions

    Title: Button is broken
    Body: It doesn't work sometimes when I click it
    

    Which button? Which page? What are the reproduction steps? Critical information is missing.

    Inconsistent Formatting

    When reproduction steps and expected behavior aren't organized, developers spend extra time just understanding the situation before they can start working.

    Information Overload Without Clear Takeaways

    Sometimes issues are filled with raw logs and stack traces but lack a clear summary of the actual problem.

    Rewrite Issue uses AI to parse these issues, extract the key points, and restructure them into a clear, organized format.

    How to Use It

    Step-by-Step Guide

    1. Navigate to the Run page and select the "Issue Run" tab
    2. Choose "Rewrite Issue" from the mode selection
    3. Paste the issue URL
      • Format: https://github.com/owner/repo/issues/123
      • Simply copy the URL from the GitHub issue page
    4. Select your GitHub account
    5. Click "Start Issue Run" to run

    That's all it takes. The AI will analyze the repository context and rewrite the issue accordingly.

    Selecting a GitHub Account

    Choose a GitHub account that has write access to the repository containing the target issue. Since Rewrite Issue updates the issue content directly, read-only accounts won't work.

    For instructions on setting up GitHub accounts, see the GitHub Account Management Guide.

    Before and After: What Rewriting Looks Like

    Here's an example of how Rewrite Issue transforms an issue.

    Before (Original)

    Title: Can't log in
    
    Clicking the login button shows an error.
    I think it was working yesterday.
    Checked on Chrome.
    

    After (Rewritten)

    Title: Authentication error occurs when clicking the login button
    
    ## Summary
    Clicking the login button on the login page triggers an authentication
    error, preventing login from completing.
    
    ## Steps to Reproduce
    1. Navigate to the login page
    2. Enter email and password
    3. Click the "Login" button
    4. An error message is displayed
    
    ## Environment
    - Browser: Chrome
    - Timeline: Recent occurrence (was working the previous day)
    
    ## Expected Behavior
    Login completes successfully and the user is redirected to the dashboard.
    

    The AI fills in contextual gaps and organizes the information into reproduction steps, environment details, and expected behavior.

    Use Cases

    Improving Existing Issue Quality

    Quickly-written issues or external bug reports with insufficient detail can be bulk-improved with Rewrite Issue, raising the overall quality of your backlog.

    Raising the Bar for Your Entire Team

    Getting everyone on a team to write great issues is hard. When team members see AI-rewritten issues as examples, they naturally start adopting better writing practices. Rewrite Issue becomes a teaching tool, not just an editing one.

    Combining with Issue Run (Create)

    Issues automatically generated by Issue Run's Create mode can be further refined with Rewrite Issue, tailoring them even more closely to your project's conventions and context.

    Things to Keep in Mind

    Always Review Rewritten Issues

    AI rewriting isn't perfect. The AI may occasionally misinterpret the original intent or add unnecessary details. Always review the rewritten content and make corrections as needed.

    Write Access Required

    Rewrite Issue directly updates the issue content. You'll need a GitHub account with write access to the target repository.

    Original Information Is Preserved

    Rewriting improves the presentation of the issue, not the underlying information. The original report's content is preserved and reorganized into a more readable format.

    Summary

    • Rewrite Issue automatically rewrites existing GitHub issues using AI
    • Transforms vague or poorly structured issues into clear, organized descriptions
    • Simple to use—just paste the issue URL and run
    • Always review rewritten results to verify accuracy
    • Combine with Create Issue and Close Issue for comprehensive issue management

    Clear issues are the foundation of smooth development. Use Rewrite Issue to elevate the quality of your team's issues and keep your projects moving forward.

    Get Started with DevLoop Runner

    Auto-generate PRs from GitHub Issues. Let AI accelerate your development.