Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add default github issue templates under ros2 org. #3

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

fujitatomoya
Copy link

Copy link
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.

I would like to get more feedback here as default issue templates under ros2 org. any comments are welcome! thanks in advance.

CC: @clalancette @kscottz

.github/ISSUE_TEMPLATE/bug_report.yml Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yml Show resolved Hide resolved
.github/ISSUE_TEMPLATE/config.yml Show resolved Hide resolved
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.

Hi Tomoya,

This is certainly better than what we presently have so I'll approve it. I've made a couple of suggestions comments. We may want to discuss further at the PMC meeting next week.

.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yml Show resolved Hide resolved
.github/ISSUE_TEMPLATE/config.yml Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature_request.yml Show resolved Hide resolved
Copy link
Contributor

@clalancette clalancette left a comment

Choose a reason for hiding this comment

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

Overall, I like the idea.

However, I do think we should strive to have a minimum of fields here. The more we have, the more confusing it is for people to report bugs (and a number of things will be filled in incorrectly anyway). I've left a couple of comments inline towards making this simpler.

.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
@fujitatomoya
Copy link
Author

@clalancette can you review this? i think it is okay to deploy, and if any repositories have their own templates, this will not affect them. IMO, it is hard to complete the perfect format, so would like to get some feedback from time to time.

fujitatomoya and others added 3 commits November 22, 2024 09:01
Signed-off-by: Tomoya.Fujita <[email protected]>
Co-authored-by: Peter Borkuti <[email protected]>
Signed-off-by: Tomoya.Fujita <[email protected]>
Co-authored-by: Katherine Scott <[email protected]>
@fujitatomoya fujitatomoya force-pushed the fujitatomoya/org-issue-template branch from 50b7578 to 3f671c1 Compare November 22, 2024 17:03
@fujitatomoya
Copy link
Author

@clalancette is there anything i can do on my side?

@fujitatomoya
Copy link
Author

fujitatomoya commented Jan 17, 2025

according to the issue template status below, what i need to do is,

  • create dedicated ros2_documentation issue template. (global template is more for runtime problem, not well suited for documentation)
  • remove all deprecated .github/ISSUE_TEMPLATE.md for each repository.
  • make an announcement on ROS discourse.

once all of those PRs are approved, we can merge all together.

Issue Template Status

  • .github/ISSUE_TEMPLATE.md is deprecated, since the repository does not maintain the template for a long time, it is okay to remove that and consider the global template can be applied against previous one.
  • if .github/ISSUE_TEMPLATE exists, that can override the organization global templates. this needs to be considered if that can be replaced by the global template if those are similar format.
  • quoted repositories are ROS PMC maintained repositories under ros2 organization.
Repository Name Template Status Modification
ament_cmake_ros Deprecated Global template can be applied
apex_rostest N.A Not required
build_farmer N.A Not required
buildfarm_perf_tests N.A Not required
cartographer N.A Not required
cartographer_ros Effective Keep them as they are
ceres-solver N.A Not required
choco-packages N.A Not required
ci N.A Not required
common_interfaces Deprecated Global template can be applied
console_bridge N.A Global template can be applied
cookbook N.A Not required
darknet_vendor N.A Not required
demos Deprecated Global template can be applied
depthimage_to_laserscan N.A Not required
design N.A Global template can be applied
detection_visualizer N.A Not required
docs.ros2.org N.A Not required
domain_bridge N.A Not required
eigen3_cmake_module N.A Global template can be applied
example_interfaces Deprecated Global template can be applied
examples Deprecated Global template can be applied
freertps N.A Not required
geometry2 Deprecated Global template can be applied
ifcfg_vendor N.A Not required
joystick_drivers N.A Not required
joystick_drivers_from_scratch N.A Not required
kdl_parser N.A Not required
launch Deprecated Global template can be applied
launch_ros Deprecated Global template can be applied
libyaml_vendor N.A Global template can be applied
message_filters N.A Global template can be applied
middleware_working_group Effective Keep them as they are
Mimick N.A Not required
mimick_vendor N.A Global template can be applied
navigation N.A Not required
netperf N.A Not required
openrobotics_darknet_ros N.A Not required
orocos_kdl_vendor N.A Global template can be applied
orocos_kinematics_dynamics N.A Not required
pcl_conversions N.A Not required
performance_test N.A Not required
performance_test_fixture N.A Global template can be applied
poco_vendor N.A Not required
pybind11_vendor N.A Global template can be applied
python_cmake_module N.A Global template can be applied
rcl Deprecated Global template can be applied
rclc Effective Keep them as they are
rcl_content_filter_fallback N.A Not required
rclcpp Deprecated Global template can be applied
rcl_interfaces Deprecated Global template can be applied
rcl_logging N.A Global template can be applied
rclpy Deprecated Global template can be applied
rcpputils N.A Global template can be applied
rcutils N.A Global template can be applied
realtime_support Deprecated Global template can be applied
release-tracking N.A Not required
rmw Deprecated Global template can be applied
rmw_connext Deprecated Global template can be applied
rmw_connextdds Effective Keep them as they are
rmw_cyclonedds Deprecated Global template can be applied
rmw_dds_common Deprecated Global template can be applied
rmw_dps Deprecated Global template can be applied
rmw_fastrtps Deprecated Global template can be applied
rmw_freertps N.A Not required
rmw_gurumdds N.A Not required
rmw_iceoryx N.A Not required
rmw_implementation Deprecated Global template can be applied
rmw_opensplice Deprecated Global template can be applied
rmw_zenoh N.A Global template can be applied
robot_model N.A Not required
robot_state_publisher N.A Not required
ros1_bridge Deprecated Global template can be applied
ros2 Deprecated Global template can be applied
ros2cli Deprecated Global template can be applied
ros2cli_common_extensions Deprecated Global template can be applied
ros2_dds_profiles_examples` N.A Not required
ros2doc` N.A Not required
ros2_documentation N.A Should have doc issue template to override the global
ros2_embedded_freertos` N.A Not required
ros2_embedded_nuttx` N.A Not required
ros2_embedded_riot` N.A Not required
ros2_embedded_sublime` N.A Not required
ros2_generate_interface_docs` N.A Not required
ros2.github.io` N.A Not required
ros2_tracing N.A Global template can be applied
ros_astra_camera` N.A Not required
rosbag2 Effective Keep them as they are
rosbag2_bag_v2 N.A Not required
rosbridge_suite N.A Not required
ros_buildfarm_config N.A Not required
ros_core_documentation N.A Not required
rosdistro N.A Not required
rosidl Deprecated Global template can be applied
rosidl_core N.A Global template can be applied
rosidl_dds Deprecated Global template can be applied
rosidl_defaults Deprecated Global template can be applied
rosidl_dynamic_typesupport N.A Global template can be applied
rosidl_dynamic_typesupport_fastrtps N.A Global template can be applied
rosidl_python Deprecated Global template can be applied
rosidl_runtime_py N.A Global template can be applied
rosidl_typesupport Deprecated Global template can be applied
rosidl_typesupport_connext Deprecated Global template can be applied
rosidl_typesupport_fastrtps Deprecated Global template can be applied
rosidl_typesupport_gurumdds N.A Not required
rosidl_typesupport_opensplice Deprecated Global template can be applied
ros_network_viz N.A Not required
ros_testing N.A Global template can be applied
ros_workspace N.A Not required
rpyutils N.A Global template can be applied
rviz N.A Global template can be applied
slide_show N.A Not required
spdlog_vendor N.A Global template can be applied
sros2 Deprecated Global template can be applied
stlink N.A Not required
system_tests Deprecated Global template can be applied
teleop_twist_joy N.A Not required
teleop_twist_keyboard N.A Not required
test_interface_files N.A Global template can be applied
tinq-core N.A Not required
tinydir_vendor N.A Not required
tinyxml2_vendor N.A Global template can be applied
tinyxml_vendor N.A Global template can be applied
tlsf N.A Not required
tsc_working_group_governance_template Effective Keep them as they are
turtlebot2_demo Deprecated Global template can be applied
tutorials N.A Not required
unique_identifier N.A Not required
unique_identifier_msgs N.A Global template can be applied
urdf Deprecated Global template can be applied
urdfdom N.A Not required
urdfdom_headers N.A Not required
variants N.A Not required
vision_opencv N.A Not required
yaml_cpp_vendor N.A Global template can be applied

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.

Make issue templates consistent across repositories.
3 participants