Skip to content

3di | Triaging and reporting an issue#6901

Open
keithkirkwood-3di wants to merge 16 commits into
ros2:rollingfrom
3di-for-openrobotics:triaging-reporting-an-issue
Open

3di | Triaging and reporting an issue#6901
keithkirkwood-3di wants to merge 16 commits into
ros2:rollingfrom
3di-for-openrobotics:triaging-reporting-an-issue

Conversation

@keithkirkwood-3di

@keithkirkwood-3di keithkirkwood-3di commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Description

Refactor/consolidation and partial rewrite of content from several sources to create new articles for Triaging an issue, and Reporting an issue under Contributing section.

Related to: #6828

Did you use Generative AI?

No

Additional Information

Documentation updates from 3di Information Solutions, agreed with Geoff and Tully.

@keithkirkwood-3di

Copy link
Copy Markdown
Contributor Author

@kscottz @tfoote Hello - I've had an odd linter failure in this PR. Doesn't look like anything to do with my updates (I think). Could you advise on what I should do here?

Comment thread source/The-ROS2-Project/Contributing/Contributing-to-code/Reporting-an-issue.rst Outdated

@fujitatomoya fujitatomoya left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

i have a couple of minor comments on this PR.

i do understand that this PR is trying to restructure the tree but it would be nice to fix at the same time. btw, my comments should not block this PR.

Comment thread source/The-ROS2-Project/Contributing/Contributing-to-code/Reporting-an-issue.rst Outdated
Comment thread source/The-ROS2-Project/Contributing/Contributing-to-code/Reporting-an-issue.rst Outdated

@kscottz kscottz left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This is a good start but there's probably some more context that we could provide to make it better. Since this is geared towards new users there's a couple of things that we're failing to mention / cross reference in the documentation, including:

  • How to figure out what ROS package is causing the issue and where to find that package's source code repository.
  • How to use ros2 doctor to report your system configuration.
  • As @fujitatomoya mentioned, how to use the report template.
  • Where to find the appropriate log files in ROS.

Comment thread source/The-ROS2-Project/Contributing/Contributing-to-code/Reporting-an-issue.rst Outdated
Comment thread source/The-ROS2-Project/Contributing/Contributing-to-code/Reporting-an-issue.rst Outdated
Comment thread source/The-ROS2-Project/Contributing/Contributing-to-code/Triaging-an-issue.rst Outdated
Comment thread source/The-ROS2-Project/Contributing/Contributing-to-code/Reporting-an-issue.rst Outdated
Comment thread source/The-ROS2-Project/Contributing/Contributing-to-code/Reporting-an-issue.rst Outdated
Comment thread source/The-ROS2-Project/Contributing/Contributing-to-code/Triaging-an-issue.rst Outdated
Comment thread source/The-ROS2-Project/Contributing/Contributing-to-code/Triaging-an-issue.rst Outdated
gbiggs added 3 commits July 17, 2026 15:07
Signed-off-by: Geoffrey Biggs <gbiggs@killbots.net>
Signed-off-by: Geoffrey Biggs <gbiggs@killbots.net>
Signed-off-by: Geoffrey Biggs <gbiggs@killbots.net>
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.

5 participants