Menu

#1408 Update issue templates

open
nobody
None
2025-09-16
2025-09-10
Anonymous
No

Originally created by: themoriarti

I suggest adding templates for bug and feature request submissions.

Summary by CodeRabbit

  • Documentation
  • Added a standardized bug report issue template to streamline submissions.
  • Prompts for environment details (version, provider), clear reproduction steps, expected vs. actual behavior, logs, screenshots, and additional context.
  • Includes a checklist to ensure completeness and that contributors searched for existing issues.
  • Made available when opening a new GitHub issue to improve clarity and speed triage.

Discussion

  • Anonymous

    Anonymous - 2025-09-10

    Originally posted by: coderabbitai[bot]

    [!NOTE]

    Other AI code review bot(s) detected

    CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

    Walkthrough

    Adds a new GitHub bug-report issue template at .github/ISSUE_TEMPLATE/bug_report.md with YAML front matter (name, about, labels, assignees) and a structured body that collects: Describe the bug; Environment (Cozystack version and Provider options); To Reproduce (steps); Actual behaviour; Logs; Screenshots; Additional context; and a Checklist.

    Changes

    Cohort / File(s) Summary of Changes
    Repo meta / Issue templates
    .github/ISSUE_TEMPLATE/bug_report.md
    Adds a standardized bug report issue template with YAML front matter (name, about, labels, assignees) and body sections: Describe the bug; Environment (Cozystack version and Provider options); To Reproduce (Steps 1–4); Actual behaviour; Logs (fenced code block for redacted logs); Screenshots; Additional context; and a Checklist of five items.

    Sequence Diagram(s)

    Estimated code review effort

    🎯 1 (Trivial) | ⏱️ ~3 minutes

    Poem

    I twitch my ears at tidy forms, hooray!
    A template guides our bugs to light of day.
    Steps, logs, pics—neatly in a row,
    So fixes hop faster, off we go!
    🐇✨

    [!TIP]


    👮 Agentic pre-merge checks are now available in preview!

    Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

    • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
    • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

    Please see the documentation for more information.

    Example:

    yaml reviews: pre_merge_checks: custom_checks: - name: "Undocumented Breaking Changes" mode: "warning" instructions: | Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

    Please share your feedback with us on this Discord post.

    Pre-merge checks (3 passed)

    ✅ Passed checks (3 passed) | Check name | Status | Explanation | | :----------------: | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Description Check | ✅ Passed | Check skipped - CodeRabbit’s high-level summary is enabled. | | Title Check | ✅ Passed | The title "Update issue templates" accurately summarizes the primary change in the PR — adding/updating GitHub issue templates (including a bug_report.md) — and is concise and on-topic. It avoids noisy details like file lists or emojis and communicates the main intent clearly. A teammate scanning PR history will understand the purpose without inspecting the full diff. | | Docstring Coverage | ✅ Passed | No functions found in the changes. Docstring coverage check skipped. |
    ✨ Finishing touches
    🧪 Generate unit tests - [ ] Create PR with unit tests - [ ] Post copyable unit tests in a comment - [ ] Commit unit tests in branch `themoriarti-issue-templates-bug`

    Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

    ❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

    Comment @coderabbitai help to get the list of available commands and usage tips.

     
  • Anonymous

    Anonymous - 2025-09-16

    Originally posted by: themoriarti

    What else needs to be fixed or added?

     

Log in to post a comment.