Skip to content

Refresh GitHub issue templates#15

Merged
renecannao merged 3 commits intomasterfrom
phase1/task9-issue-templates
Mar 23, 2026
Merged

Refresh GitHub issue templates#15
renecannao merged 3 commits intomasterfrom
phase1/task9-issue-templates

Conversation

@renecannao
Copy link
Copy Markdown

Summary

  • Updated bug report template with structured fields for dbdeployer version, Go version, MySQL version/flavor, OS, and topology type; separated expected vs actual behavior sections
  • Updated feature request template with a component/provider checklist covering MySQL, ProxySQL, Orchestrator, PostgreSQL, and Core

Closes #9

Copilot AI review requested due to automatic review settings March 23, 2026 19:08
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the repository’s GitHub issue templates to collect more structured information for faster triage and clearer feature scoping (per #9).

Changes:

  • Expanded the bug report template with an “Environment” block (versions/OS/topology) and separated expected vs actual behavior.
  • Added a component/provider checklist to the feature request template.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
.github/ISSUE_TEMPLATE/bug_report.md Adds structured environment fields and clarifies reproduction/expected vs actual behavior sections.
.github/ISSUE_TEMPLATE/feature_request.md Adds a component/provider checklist to better categorize feature requests.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +7 to +13
**Component/provider**
Which area does this feature relate to? (check all that apply)
- [ ] MySQL (core sandbox functionality)
- [ ] ProxySQL (integration, deployment)
- [ ] Orchestrator (integration, deployment)
- [ ] PostgreSQL (future provider)
- [ ] Core (CLI, configuration, topology engine)
Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The issue/PR description mentions capturing phase scope for feature requests, but this template only asks for component/provider. Consider adding an explicit “Phase” (e.g., Phase 1/2/3) field or adjusting the wording so it matches the stated acceptance criteria and closes #9 accurately.

Copilot uses AI. Check for mistakes.
@renecannao
Copy link
Copy Markdown
Author

@gemini-code-assist review

@renecannao
Copy link
Copy Markdown
Author

@claude review

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request effectively refreshes the GitHub issue templates. The changes to the bug report template, such as adding a structured environment section and separating expected from actual behavior, will greatly improve the quality of bug reports. Similarly, the new component checklist in the feature request template is a welcome addition for better issue triaging. I've added a couple of minor suggestions to further enhance the information gathered by these templates.

- Total RAM
**Hardware (if applicable)**
- Free storage:
- Total RAM:
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

In the Hardware section, it would be beneficial to also ask for CPU details, as this can be relevant for performance-related issues. Consider adding a field for it.

Suggested change
- Total RAM:
- Total RAM:
- CPU: [e.g. 2 cores, 4 threads]

- [ ] ProxySQL (integration, deployment)
- [ ] Orchestrator (integration, deployment)
- [ ] PostgreSQL (future provider)
- [ ] Core (CLI, configuration, topology engine)
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To catch feature requests that don't fit into the predefined categories, consider adding an 'Other' option to the Component/provider checklist. This would also help users who are unsure where their suggestion fits.

Suggested change
- [ ] Core (CLI, configuration, topology engine)
- [ ] Core (CLI, configuration, topology engine)
- [ ] Other (please specify)

@renecannao
Copy link
Copy Markdown
Author

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 23, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 23, 2026

Warning

Rate limit exceeded

@renecannao has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 13 minutes and 20 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 16b1757a-31d3-481c-a378-6b531d73e45f

📥 Commits

Reviewing files that changed from the base of the PR and between d51b93e and 407d4f7.

📒 Files selected for processing (8)
  • .github/ISSUE_TEMPLATE/bug_report.md
  • .github/ISSUE_TEMPLATE/feature_request.md
  • CONTRIBUTING.md
  • README.md
  • downloads/guess_latest.go
  • downloads/remote_registry_test.go
  • downloads/remote_tarballs.go
  • downloads/tarball_list.json
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch phase1/task9-issue-templates

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

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

@renecannao renecannao force-pushed the phase1/task9-issue-templates branch from d5b19ae to 407d4f7 Compare March 23, 2026 20:16
@renecannao renecannao merged commit 5219d4a into master Mar 23, 2026
4 of 11 checks passed
@renecannao renecannao deleted the phase1/task9-issue-templates branch March 23, 2026 20:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Refresh GitHub issue templates

2 participants