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

feat: apply autoware_ prefix for hazard_status_converter #9971

Conversation

sasakisasaki
Copy link
Contributor

@sasakisasaki sasakisasaki commented Jan 19, 2025

Description

This pull request addresses the issue of inconsistent naming by adding the autoware_ prefix to relevant components. This change ensures uniformity across the codebase and aligns with the project's naming conventions.

Related Links

How was this PR tested?

Currently, we only verified that the build succeeds. Further checks will be performed by using the updated module. This PR will be ready for review after finishing all the necessary checks/tests.

  • Directory Name

    • Add autoware_ as a prefix to the directory name.
  • packages.xml

    • Add autoware_ to the name element.
  • CMakeLists.txt

    • Change the project name to autoware_***.
    • Add autoware:: to PLUGIN.
  • Header Files (.hpp)

    • Start #ifndef guards with AUTOWARE__.
    • Add autoware:: to namespace.
  • Source Files (.cpp)

    • Add autoware:: inside RCLCPP_COMPONENTS_REGISTER_NODE.
  • Launch Files

    • Add autoware_ before find-pkg-share.
    • Change node pkg="<pkgname>" to autoware_<pkgname>.
  • Include

    • Add autoware folder as necessary and update include statements accordingly.
    • Check for impacts on other packages.
  • Verification Points

    • Search find-pkg-share in autoware
    • Check README file (especially json schema)
    • Pay attention to complex cases like sensor_launch as seen in gnss_poser

Notes for Reviewers

None.

Interface Changes

None.

Effects on System Behavior

All the developers who were using hazard_status_converter needs to modify their code. This is maybe kind of non quick-win task.

@github-actions github-actions bot added type:documentation Creating or refining documentation. (auto-assigned) component:system System design and integration. (auto-assigned) labels Jan 19, 2025
Copy link

github-actions bot commented Jan 19, 2025

Thank you for contributing to the Autoware project!

🚧 If your pull request is in progress, switch it to draft mode.

Please ensure:

@sasakisasaki sasakisasaki added the run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) label Jan 19, 2025
@sasakisasaki sasakisasaki marked this pull request as ready for review January 20, 2025 02:35
Copy link

codecov bot commented Jan 20, 2025

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 29.45%. Comparing base (9c39d3f) to head (5b22fda).
Report is 15 commits behind head on main.

Files with missing lines Patch % Lines
...autoware_hazard_status_converter/src/converter.cpp 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #9971      +/-   ##
==========================================
- Coverage   29.79%   29.45%   -0.34%     
==========================================
  Files        1434     1426       -8     
  Lines      108244   107759     -485     
  Branches    42930    42791     -139     
==========================================
- Hits        32247    31742     -505     
- Misses      72868    72956      +88     
+ Partials     3129     3061      -68     
Flag Coverage Δ *Carryforward flag
differential 0.00% <0.00%> (?)
total 29.47% <ø> (-0.33%) ⬇️ Carriedforward from 0da8d5e

*This pull request uses carry forward flags. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@@ -1,4 +1,4 @@
// Copyright 2023 The Autoware Contributors
// Copyright 2025 The Autoware Contributors
Copy link
Contributor

Choose a reason for hiding this comment

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

Please keep the copyright year. This is the publication year.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed by this commit

@@ -1,4 +1,4 @@
// Copyright 2023 The Autoware Contributors
// Copyright 2025 The Autoware Contributors
Copy link
Contributor

Choose a reason for hiding this comment

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

Please keep the copyright year. This is the publication year.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed by this commit

sasakisasaki and others added 5 commits January 22, 2025 14:36
…verter' of github.com:sasakisasaki/autoware.universe into feat-apply-autoware-prefix-for-system-hazard-status-converter

Signed-off-by: Junya Sasaki <[email protected]>
Copy link
Contributor

@isamu-takagi isamu-takagi left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@SakodaShintaro SakodaShintaro left a comment

Choose a reason for hiding this comment

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

I think that the following line needs to be fixed.

<include file="$(find-pkg-share hazard_status_converter)/launch/hazard_status_converter.launch.xml"/>

@github-actions github-actions bot added the component:launch Launch files, scripts and initialization tools. (auto-assigned) label Jan 23, 2025
Copy link
Contributor

@SakodaShintaro SakodaShintaro left a comment

Choose a reason for hiding this comment

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

I pushed a necessary change.
0da8d5e

@mitsudome-r mitsudome-r merged commit 1794419 into autowarefoundation:main Jan 24, 2025
34 checks passed
@mitsudome-r
Copy link
Member

I forgot to attach the evaluator result (TIER IV Internal link):
https://evaluation.ci.tier4.jp/evaluation/reports/53e058e2-47af-559a-974f-6c3520d709b5?project_id=prd_jt

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:launch Launch files, scripts and initialization tools. (auto-assigned) component:system System design and integration. (auto-assigned) run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) type:documentation Creating or refining documentation. (auto-assigned)
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants