LCORE-1457 Add SUPPORT.md, which appears with info when opening a GH issue#1315
Conversation
WalkthroughUpdated the bug report template heading to "Lightspeed Stack version" and added a new SUPPORT.md file documenting bug reporting procedures for both external contributors via GitHub issues and Red Hat contributors via Jira. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan for PR comments
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@SUPPORT.md`:
- Line 3: Confirm with `@ptisnovs` whether they should be tagged for urgent issues
and then replace the HTML FIXME comment in the "For urgent issues..." line:
either explicitly instruct "For urgent issues, tag `@ptisnovs` in the issue" if
they agree, or update the guidance to an alternative escalation path (e.g., "For
urgent issues, open an issue, add the 'urgent' label, and notify the maintainers
via the org Slack `#support` or mention the `@maintainers` team") so the FIXME is
removed and the urgent-escalation step is fully specified.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 76c29a31-c330-498d-8668-476feb8fee45
📒 Files selected for processing (2)
.github/ISSUE_TEMPLATE/bug_report.mdSUPPORT.md
| @@ -0,0 +1,6 @@ | |||
| # Reporting bugs | |||
|
|
|||
| * **External contributors**: Open a [GitHub Issue](https://github.com/lightspeed-core/lightspeed-stack/issues/new?template=bug_report.md) using the bug report template. For urgent issues, tag <!-- FIXME: is it fine @ptisnovs to tag you like this? --> in the issue. | |||
There was a problem hiding this comment.
Resolve the FIXME comment and complete the urgent issue guidance.
Line 3 contains an unresolved FIXME comment asking for confirmation about tagging someone, and the urgent issue escalation path for external contributors is incomplete. The text reads "For urgent issues, tag in the issue" without specifying who or what to tag.
Please resolve the following before merging:
- Confirm with
@ptisnovs(or the appropriate person/team) whether they should be tagged for urgent issues - Complete the guidance by either:
- Specifying the person/team to tag (e.g., "tag
@ptisnovsin the issue"), or - Providing alternative escalation instructions if tagging is not appropriate
- Specifying the person/team to tag (e.g., "tag
Would you like me to suggest alternative escalation patterns commonly used in open-source projects?
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@SUPPORT.md` at line 3, Confirm with `@ptisnovs` whether they should be tagged
for urgent issues and then replace the HTML FIXME comment in the "For urgent
issues..." line: either explicitly instruct "For urgent issues, tag `@ptisnovs` in
the issue" if they agree, or update the guidance to an alternative escalation
path (e.g., "For urgent issues, open an issue, add the 'urgent' label, and
notify the maintainers via the org Slack `#support` or mention the `@maintainers`
team") so the FIXME is removed and the urgent-escalation step is fully
specified.
1 participant
Description
Add SUPPORT.md with info on reporting bugs.
Type of change
Tools used to create PR
Identify any AI code assistants used in this PR (for transparency and review context)
Related Tickets & Documents
Summary by CodeRabbit