Skip to content

chore: add bug reporting docs#3795

Open
hopehadfield wants to merge 2 commits into
redhat-developer:mainfrom
hopehadfield:bug-reporting
Open

chore: add bug reporting docs#3795
hopehadfield wants to merge 2 commits into
redhat-developer:mainfrom
hopehadfield:bug-reporting

Conversation

@hopehadfield

Copy link
Copy Markdown
Member

Hey, I just made a Pull Request!

Addresses https://redhat.atlassian.net/browse/RHIDP-15084

✔️ Checklist

  • A changeset describing the change and affected packages. (more info)
  • Added or Updated documentation
  • Tests for new functionality and regression tests for bug fixes
  • Screenshots attached (for UI changes)

Signed-off-by: Hope Hadfield <hhadfiel@redhat.com>
@hopehadfield
hopehadfield requested review from a team as code owners July 16, 2026 14:31
@github-actions

Copy link
Copy Markdown
Contributor

This pull request adds a new top-level directory under workspaces/. Please follow Submitting a Pull Request for a New Workspace in CONTRIBUTING.md.

@rhdh-qodo-merge

Copy link
Copy Markdown

PR Summary by Qodo

Add bug reporting guide and link from CONTRIBUTING

📝 Documentation 🕐 Less than 10 minutes

Grey Divider

AI Description

• Add a dedicated bug reporting guide for filing issues in RHDHBUGS.
• Document required fields, priority guidance, and upstream (Backstage) escalation workflow.
• Link the new guide from CONTRIBUTING plugin owner responsibilities.
High-Level Assessment

The approach is appropriate for this repo: keep the detailed workflow in a dedicated doc and reference it from CONTRIBUTING to improve discoverability without bloating guidelines.

Files changed (2) +81 / -0

Documentation (2) +81 / -0
CONTRIBUTING.mdAdd reference to the Bug Reporting Guide +1/-0

Add reference to the Bug Reporting Guide

• Adds a new plugin owner responsibility bullet pointing readers to the bug reporting documentation. Improves discoverability of the expected bug filing process.

CONTRIBUTING.md

bug-reporting.mdIntroduce RHDH bug reporting guide +80/-0

Introduce RHDH bug reporting guide

• Adds a new documentation page describing how to file bugs in the RHDHBUGS Jira project, including required fields and priority-setting guidance. Also documents how to handle upstream Backstage-originated issues while still tracking them in RHDHBUGS, including timeline considerations.

docs/bug-reporting.md

@rhdh-qodo-merge

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Qodo Logo

@rhdh-qodo-merge rhdh-qodo-merge Bot added the documentation Improvements or additions to documentation label Jul 16, 2026
Comment thread docs/bug-reporting.md
Signed-off-by: Hope Hadfield <hhadfiel@redhat.com>
@sonarqubecloud

Copy link
Copy Markdown

@04kash 04kash left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants