Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: remove shell rendering from issue templates #1495

Merged
merged 1 commit into from
Jan 28, 2025
Merged

Conversation

ofir-frd
Copy link
Collaborator

@ofir-frd ofir-frd commented Jan 28, 2025

PR Type

Bug fix, Documentation


Description

  • Removed render: shell attribute from issue templates.

  • Simplified bug report and miscellaneous templates for clarity.


Changes walkthrough 📝

Relevant files
Bug fix
bug-report.yml
Removed `render: shell` from bug report template                 

.github/ISSUE_TEMPLATE/bug-report.yml

  • Removed render: shell attribute from system-info field.
  • Removed render: shell attribute from bug-details field.
  • +0/-2     
    miscellaneous.yml
    Removed `render: shell` from miscellaneous template           

    .github/ISSUE_TEMPLATE/miscellaneous.yml

  • Removed render: shell attribute from system-info field.
  • Removed render: shell attribute from issues-details field.
  • +0/-2     

    Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
  • Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No major issues detected

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    General
    Add markdown rendering for content

    Consider adding a specific render format (like 'markdown') to the bug-details
    textarea to ensure proper formatting of user-submitted content, especially for error
    messages and logs.

    .github/ISSUE_TEMPLATE/bug-report.yml [31-38]

     - type: textarea
       id: bug-details
       attributes:
         label: Bug details
         description: Please describe the problem.
         placeholder: Describe the problem
    +    render: markdown
       validations:
         required: true
    • Apply this suggestion
    Suggestion importance[1-10]: 4

    Why: Adding 'render: markdown' could improve the readability of user-submitted bug reports, especially for code blocks and error messages. However, the PR is explicitly removing render attributes, suggesting a deliberate choice to use default rendering.

    4
    • Author self-review: I have reviewed the PR code suggestions, and addressed the relevant ones.

    @ofir-frd ofir-frd requested a review from mrT23 January 28, 2025 07:19
    @mrT23 mrT23 merged commit 456d5aa into main Jan 28, 2025
    2 checks passed
    @mrT23 mrT23 deleted the of/issue_template branch January 28, 2025 07:21
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants