Repository navigation
Update issue templates - #1408
Conversation
|
Caution Review failedThe pull request is closed. Note Other AI code review bot(s) detectedCodeRabbit 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. WalkthroughAdds a new GitHub bug-report issue template at Changes
Sequence Diagram(s)Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
Pre-merge checks (3 passed)✅ Passed checks (3 passed)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
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. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello Marian Koreniuk (@themoriarti), I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request introduces a new bug report issue template to standardize and improve the quality of bug submissions. The template aims to guide users in providing all essential information upfront, facilitating quicker understanding and resolution of reported issues.
Highlights
- New Bug Report Template: A new issue template for bug reports has been added to streamline the bug reporting process.
- Standardized Bug Information: The new template includes predefined sections for describing the bug, environment details, reproduction steps, expected behavior, logs, screenshots, and a comprehensive checklist to ensure all necessary information is provided.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | Gemini (@gemini-code-assist) | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on Gemini (@gemini-code-assist) comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request adds a new bug report issue template. The template is well-structured, but I have a couple of suggestions to improve it. I've recommended automatically adding a 'bug' label for better issue tracking and pointed out a minor typo in one of the section headers.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (4)
.github/ISSUE_TEMPLATE/bug_report.md (4)
1-8: Set sane defaults in front matter (auto-label, clearer title) or drop empty fields.Empty strings for labels/assignees are no-ops. Prefer auto-tagging bugs and a clearer title hint.
--- name: Bug report about: Create a report to help us improve -title: "[Bug]" -labels: '' -assignees: '' +title: "[Bug]: <short summary>" +labels: bug +# assignees: '' ---
13-16: Tighten environment section and grammar; prompt for key versions.“on-prem” phrasing and “or else” are awkward; add commonly needed details for triage.
-## Environment -- Cozystack version -- Provider: on-prem, Hetzner or else +## Environment +- Cozystack version (e.g., vX.Y.Z or commit SHA) +- Provider: on‑premises, Hetzner, or other (specify) +- Kubernetes version (if applicable) +- Region / datacenter +- Install method (docs link, script, helm, etc.)
39-45: Expand checklist for reproducibility and hygiene.Adds explicit asks that reduce back-and-forth.
-## Checklist -- [ ] I have checked the documentation -- [ ] I have searched for similar issues -- [ ] I have included all required information -- [ ] I have provided clear steps to reproduce -- [ ] I have included relevant logs +## Checklist +- [ ] I checked the documentation +- [ ] I searched for similar issues +- [ ] I can reproduce on the latest released version or main +- [ ] I included environment details (versions, provider, install method) +- [ ] I provided clear, minimal steps to reproduce +- [ ] I included relevant logs (with secrets redacted)
1-45: Consider migrating to GitHub Issue Forms for structured inputs.Issue Forms (.yml) give typed fields (dropdowns for provider, required logs, etc.) and reduce incomplete reports. If desired, I can draft a forms-based equivalent.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/ISSUE_TEMPLATE/bug_report.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
.github/ISSUE_TEMPLATE/bug_report.md
13-13: Spaces inside emphasis markers
(MD037, no-space-in-emphasis)
28-28: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
29-29: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
39-39: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Build
🔇 Additional comments (1)
.github/ISSUE_TEMPLATE/bug_report.md (1)
1-45: Overall: Good addition; minor polish will satisfy markdownlint.Template is solid and actionable; above tweaks fix MD036/MD037/MD040 and improve triage quality.
Signed-off-by: Marian Koreniuk <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
.github/ISSUE_TEMPLATE/bug_report.md (2)
10-39: Use proper Markdown headings instead of bold; fix "To Reproduce" label.Switch bolded section titles to ATX headings for lint/anchors; rename “To Reproduce” to “Steps to reproduce.”
-**Describe the bug** +## Describe the bug @@ -**Environment** +## Environment @@ -**To Reproduce** +## Steps to reproduce @@ -**Expected behavior** +## Expected behavior @@ -**Logs** +## Logs @@ -**Screenshots** +## Screenshots @@ -**Additional context** +## Additional context @@ -**Checklist** +## Checklist
28-31: Specify code fence language and expand redaction guidance.Adds MD040 compliance and reduces accidental leakage.
-``` -Paste any relevant logs here. Please redact tokens, passwords, private keys. -``` +```text +Paste any relevant logs here. Please redact tokens, passwords, private keys, or PII. +```
🧹 Nitpick comments (4)
.github/ISSUE_TEMPLATE/bug_report.md (4)
4-4: Avoid a fixed default title; make it a prompt.Using a static “[Bug]” becomes many identical titles. Suggest a cue.
-title: "[Bug]" +title: "[Bug]: "
13-16: Tighten wording and capture key environment fields.“or else” → “or other”; add k8s and OS for reproducibility.
- Provider: on-prem, Hetzner or else + - Provider: on-prem, Hetzner, or other + - Kubernetes version + - OS/distribution and version
39-44: Strengthen the checklist to prevent noise and leaks.Add confirmations for sanitization and issue type.
- [ ] I have provided clear steps to reproduce - [ ] I have included relevant logs + - [ ] I have redacted secrets/PII from logs and screenshots + - [ ] This is a bug report (not a usage question or support request)
45-45: Add a trailing newline at EOF.Minor formatting polish.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/ISSUE_TEMPLATE/bug_report.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
.github/ISSUE_TEMPLATE/bug_report.md
13-13: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
28-28: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
29-29: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
39-39: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🔇 Additional comments (1)
.github/ISSUE_TEMPLATE/bug_report.md (1)
5-5: Good: auto-apply the bug label.This helps triage.
Signed-off-by: Marian Koreniuk <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
.github/ISSUE_TEMPLATE/bug_report.md (1)
31-34: Specify code-fence language; reinforce secret scrubbing (MD040).Adds language hint and expands redaction note.
-``` -Paste any relevant logs here. Please redact tokens, passwords, private keys. -``` +```text +Paste any relevant logs here. Please redact tokens, passwords, private keys, or PII. +```
🧹 Nitpick comments (3)
.github/ISSUE_TEMPLATE/bug_report.md (3)
13-20: Switch bold “headings” to proper H2s; standardize wording.Resolves markdownlint MD036 and improves anchors; also standardizes “behaviour” → “behavior”.
-**Describe the bug** +## Describe the bug @@ -**Environment** +## Environment @@ -**To Reproduce** +## Steps to reproduce @@ -**Actual behaviour** +## Actual behavior @@ -**Logs** +## Logs @@ -**Screenshots** +## Screenshots @@ -**Additional context** +## Additional context @@ -**Checklist** +## ChecklistAlso applies to: 27-27, 31-31, 36-36, 39-39, 42-42
26-27: Add “Expected behavior” section (clarifies diff vs. actual).Helps triage by contrasting intended vs. observed.
4. See error @@ +## Expected behavior +A clear and concise description of what you expected to happen. + ## Actual behavior
16-19: Extend Environment fields; strengthen Checklist.Adds common diagnostics and confirmation items.
- Cozystack version -- Provider: on-prem, Hetzner, and so on +- Provider: on-prem, Hetzner, etc. +- Install method (e.g., Helm, Kustomize) +- Kubernetes version and distro (e.g., v1.30, k3s/AKS/EKS/GKE) +- OS/Arch of control plane and nodes (e.g., Ubuntu 22.04, amd64/arm64) +- Cloud/region (if applicable) @@ - [ ] I have provided clear steps to reproduce - [ ] I have included relevant logs + - [ ] I have redacted secrets and PII from logs and screenshots + - [ ] I agree to follow the Code of ConductAlso applies to: 42-47
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/ISSUE_TEMPLATE/bug_report.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
.github/ISSUE_TEMPLATE/bug_report.md
16-16: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
31-31: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
32-32: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
42-42: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Build
|
What else needs to be fixed or added? |
Hi, thanks for the contribution. This fell through the cracks. I've reassigned this to myself and we'll take care of the review asap. |
Signed-off-by: Timofei Larkin <[email protected]>
|
Looks good. A counterpart to "Actual behaviour" was missing. I've added an "Expected behavior" section and merged. Thanks for taking the time to improve this. |
3 participants
I suggest adding templates for bug and feature request submissions.
Summary by CodeRabbit