Skip to content

add github issue template.#5140

Merged
fujitatomoya merged 2 commits intorollingfrom
fujitatomoya/issue-report-template
Mar 25, 2025
Merged

add github issue template.#5140
fujitatomoya merged 2 commits intorollingfrom
fujitatomoya/issue-report-template

Conversation

@fujitatomoya
Copy link
Collaborator

related to ros2/.github#3

ros2/.github#3 tries to add project global issue template in default.
This PR aims to have documentation specific template to override the global one because global template is more like software component issue template.

see more details for ros2/.github#3 (comment)

@github-actions
Copy link

github-actions bot commented Mar 20, 2025

HTML artifacts: https://github.com/ros2/ros2_documentation/actions/runs/14051340790/artifacts/2812913959.

To view the resulting site:

  1. Click on the above link to download the artifacts archive
  2. Extract it
  3. Open html-artifacts-5140/index.html in your favorite browser

Copy link
Collaborator Author

@fujitatomoya fujitatomoya left a comment

Choose a reason for hiding this comment

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

@kscottz @christophebedard
CC: @mjcarroll

one more enhancement for ROS 2 documentation 📝

I talked about this several weeks ago in the PMC meeting.

this issue template is for documentation specific, and meant to override global software issue template ros2/.github#3.

create_new_issue create_new_issue_2

you can test it on https://github.com/fujitatomoya/github_test/issues, i applied this template there.

Note

This PR is independent, so if this is approved, we do not have to wait for ros2/.github#3

@fujitatomoya fujitatomoya added the backport-all backport at reviewers discretion; from rolling to all versions label Mar 20, 2025
Copy link
Member

@christophebedard christophebedard left a comment

Choose a reason for hiding this comment

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

This looks great to me!

@fujitatomoya
Copy link
Collaborator Author

@christophebedard thanks! i will wait for the feedback from @kscottz for this before merge.

Copy link
Collaborator

@kscottz kscottz left a comment

Choose a reason for hiding this comment

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

This is fantastic. No notes.

@kscottz kscottz self-requested a review March 24, 2025 22:19
Copy link
Collaborator

@kscottz kscottz left a comment

Choose a reason for hiding this comment

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

The issue template itself is perfect, but the links threw me for a loop. I tried to make them more conversational. I think the links themselves are good and we should consider rolling them out across the organization.

@fujitatomoya
Copy link
Collaborator Author

@kscottz i borrowed your suggestions, thanks!

@fujitatomoya
Copy link
Collaborator Author

@Mergifyio rebase

fujitatomoya and others added 2 commits March 25, 2025 03:57
Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Signed-off-by: Tomoya.Fujita <tomoya.fujita825@gmail.com>
Co-authored-by: Katherine Scott <katherineAScott@gmail.com>
@mergify
Copy link
Contributor

mergify bot commented Mar 25, 2025

rebase

✅ Branch has been successfully rebased

@fujitatomoya fujitatomoya force-pushed the fujitatomoya/issue-report-template branch from f667c95 to 7d55e05 Compare March 25, 2025 03:57
@fujitatomoya fujitatomoya merged commit 96636c1 into rolling Mar 25, 2025
5 checks passed
@fujitatomoya fujitatomoya deleted the fujitatomoya/issue-report-template branch March 25, 2025 04:02
mergify bot pushed a commit that referenced this pull request Mar 25, 2025
* add github issue template.

Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>

* update desscription of config.yml to be more user-friendly.

Signed-off-by: Tomoya.Fujita <tomoya.fujita825@gmail.com>
Co-authored-by: Katherine Scott <katherineAScott@gmail.com>

---------

Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Signed-off-by: Tomoya.Fujita <tomoya.fujita825@gmail.com>
Co-authored-by: Katherine Scott <katherineAScott@gmail.com>
(cherry picked from commit 96636c1)
mergify bot pushed a commit that referenced this pull request Mar 25, 2025
* add github issue template.

Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>

* update desscription of config.yml to be more user-friendly.

Signed-off-by: Tomoya.Fujita <tomoya.fujita825@gmail.com>
Co-authored-by: Katherine Scott <katherineAScott@gmail.com>

---------

Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Signed-off-by: Tomoya.Fujita <tomoya.fujita825@gmail.com>
Co-authored-by: Katherine Scott <katherineAScott@gmail.com>
(cherry picked from commit 96636c1)
@ros-discourse
Copy link

This pull request has been mentioned on ROS Discourse. There might be relevant details there:

https://discourse.ros.org/t/new-issue-template-added-for-ros-2-documentation/42779/1

@fujitatomoya
Copy link
Collaborator Author

@kscottz @christophebedard

announcement has been posted on https://discourse.ros.org/t/new-issue-template-added-for-ros-2-documentation/42779 ! thanks for the review and suggestions!

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

Labels

backport-all backport at reviewers discretion; from rolling to all versions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants