Skip to content

LCORE-1457 Add SUPPORT.md, which appears with info when opening a GH issue#1315

Merged
tisnik merged 2 commits intolightspeed-core:mainfrom
max-svistunov:lcore-1457-contrib-guide-bug-reporting
Mar 19, 2026
Merged

LCORE-1457 Add SUPPORT.md, which appears with info when opening a GH issue#1315
tisnik merged 2 commits intolightspeed-core:mainfrom
max-svistunov:lcore-1457-contrib-guide-bug-reporting

Conversation

@max-svistunov
Copy link
Copy Markdown
Contributor

@max-svistunov max-svistunov commented Mar 12, 2026

Description

Add SUPPORT.md with info on reporting bugs.

Type of change

  • Refactor
  • New feature
  • Bug fix
  • CVE fix
  • Optimization
  • Documentation Update
  • Configuration Update
  • Bump-up service version
  • Bump-up dependent library
  • Bump-up library or tool used for development (does not change the final image)
  • CI configuration change
  • Konflux configuration change
  • Unit tests improvement
  • Integration tests improvement
  • End to end tests improvement
  • Benchmarks improvement

Tools used to create PR

Identify any AI code assistants used in this PR (for transparency and review context)

  • Assisted-by: Claude Opus 4.6
  • Generated by: Claude Opus 4.6

Related Tickets & Documents

  • Related Issue # LCORE-1457
  • Closes # LCORE-1457

Summary by CodeRabbit

  • Documentation
    • Clarified bug template to reference "Lightspeed Stack version" consistently.
    • Added a support guide detailing bug-reporting workflows (external via GitHub issues; internal via the project's tracking system), escalation paths, and required report contents including reproduction steps and expected vs. actual behavior.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 12, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: af7e6feb-e4cd-4c8e-9794-34efb60f9eb0

📥 Commits

Reviewing files that changed from the base of the PR and between 93775fb and c632617.

📒 Files selected for processing (1)
  • SUPPORT.md
✅ Files skipped from review due to trivial changes (1)
  • SUPPORT.md

Walkthrough

Changed the bug report template heading to "Lightspeed Stack version" and added SUPPORT.md outlining bug-reporting workflows for external contributors (GitHub issues) and Red Hat contributors (Jira), plus required bug-report content and escalation guidance.

Changes

Cohort / File(s) Summary
Documentation & Templates
.github/ISSUE_TEMPLATE/bug_report.md, SUPPORT.md
Updated issue template heading text and added a new SUPPORT.md describing two bug-report workflows (external via GitHub issue, internal via Jira), required report fields (steps to reproduce, expected vs actual, Lightspeed Stack version), and escalation notes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3
✅ 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 accurately describes the main change: adding a SUPPORT.md file that provides bug-reporting guidance and appears when opening GitHub issues.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
📝 Coding Plan
  • Generate coding plan for human review 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.

❤️ Share

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

Tip

You can disable sequence diagrams in the walkthrough.

Disable the reviews.sequence_diagrams setting to disable sequence diagrams in the walkthrough.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between 69b9368 and 93775fb.

📒 Files selected for processing (2)
  • .github/ISSUE_TEMPLATE/bug_report.md
  • SUPPORT.md

Copy link
Copy Markdown
Contributor

@tisnik tisnik left a comment

Choose a reason for hiding this comment

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

LGTM

@tisnik tisnik merged commit b389643 into lightspeed-core:main Mar 19, 2026
24 checks passed
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.

2 participants