feat: add coding guideline about topic message handling #543

ohsawa1204 · 2024-04-30T05:47:49Z

Description

Add coding guideline about topic message handling

Pre-review checklist for the PR author

The PR author must check the checkboxes below when creating the PR.

I've confirmed the contribution guidelines.
The PR follows the pull request guidelines.

In-review checklist for the PR reviewers

The Reviewers must check the checkboxes below before approval.

The PR follows the pull request guidelines.

Post-review checklist for the PR author

The PR author must check the checkboxes below before merging.

There are no open discussions or they are tracked via tickets.

After all checkboxes are checked, anyone who has write access can merge the PR.

Signed-off-by: ohsawa1204 <ohsawa.12.04@gmail.com>

github-actions · 2024-04-30T06:59:45Z

Documentation URL: https://autowarefoundation.github.io/autoware-documentation/pr-543/
Modified URLs:

Signed-off-by: Takayuki AKAMINE <takayuki.akamine@tier4.jp>

takam5f2 · 2024-05-01T02:01:02Z

@ohsawa1204
I'd like to ask you to create a page structure before checking the content.
I'm concerned that there is no page index on the left-hand side of the web pages.

Please follow my instruction at first. If you find some improvements on my instruction, please fix it.

add directory name of topic-message-handling to docs/contributing/coding-guidelines/ros-nodes/.pages
add new docs/contributing/coding-guidelines/ros-nodes/topic-message-handling/.pages

nav:
  - index.md
  - 01-supp-intra-process-comm.md
  - 02-supp-waitset.md

rename 00-topic-message-handling.md to index.md
fix missing link to 00-topic-message-handling.md with replace it by index.md

I sent a PR (ohsawa1204#1) to your branch to show my instructions.
Best,

Signed-off-by: Takayuki AKAMINE <takayuki.akamine@tier4.jp>

docs(topic-message-handling): create page structure using .pages

Signed-off-by: ohsawa1204 <ohsawa.12.04@gmail.com>

ohsawa1204 · 2024-05-01T02:53:13Z

@ohsawa1204 I'd like to ask you to create a page structure before checking the content. I'm concerned that there is no page index on the left-hand side of the web pages.

Please follow my instruction at first. If you find some improvements on my instruction, please fix it.

add directory name of topic-message-handling to docs/contributing/coding-guidelines/ros-nodes/.pages

add new docs/contributing/coding-guidelines/ros-nodes/topic-message-handling/.pages
nav:
  - index.md
  - 01-supp-intra-process-comm.md
  - 02-supp-waitset.md
rename 00-topic-message-handling.md to index.md

fix missing link to 00-topic-message-handling.md with replace it by index.md

I sent a PR (ohsawa1204#1) to your branch to show my instructions. Best,

@takam5f2
Thank you very much for your fix!
Your fix was merged to this PR.

Signed-off-by: ohsawa1204 <ohsawa.12.04@gmail.com>

takam5f2

@ohsawa1204
Sorry for a large number of comments. I think that straight translation makes sentences complex, my feedback is based on this thought.

...contributing/coding-guidelines/ros-nodes/topic-message-handling/00-topic-message-handling.md

docs/contributing/coding-guidelines/ros-nodes/topic-message-handling/index.md

takam5f2

Sorry for my micro-checking.

...ontributing/coding-guidelines/ros-nodes/topic-message-handling/01-supp-intra-process-comm.md

takam5f2

@ohsawa1204
I finished checking all pages. Could you check my feedback?
Perhaps, some of my feedback may not reasonable.

Best,

docs/contributing/coding-guidelines/ros-nodes/topic-message-handling/02-supp-waitset.md

…ndling/index.md Co-authored-by: Takayuki AKAMINE <38586589+takam5f2@users.noreply.github.com>

…ndling/02-supp-wait_set.md Co-authored-by: Takayuki AKAMINE <38586589+takam5f2@users.noreply.github.com>

docs/contributing/coding-guidelines/ros-nodes/topic-message-handling/index.md

…ndling/index.md Co-authored-by: Takayuki AKAMINE <38586589+takam5f2@users.noreply.github.com>

docs/contributing/coding-guidelines/ros-nodes/topic-message-handling/.pages

Signed-off-by: ohsawa1204 <ohsawa.12.04@gmail.com>

takam5f2

@ohsawa1204 Thank you for checking all of my feedback. Do you have any action on this PR? If no, I'd like ask AWF reviewers to check this PR.

Best,

ohsawa1204 · 2024-05-14T06:40:53Z

@ohsawa1204 Thank you for checking all of my feedback. Do you have any action on this PR? If no, I'd like ask AWF reviewers to check this PR.

Best,

@takam5f2
No, I don't have any remaining action.

takam5f2 · 2024-05-14T08:01:27Z

@mitsudome-r
@ohsawa1204 created the PR to add a new coding guidance using the Subscription->take() method. This was suggested in the discussion https://github.com/orgs/autowarefoundation/discussions/4612. The PR is ready to be reviewed.
Could you check the PR and invite other reviewers?
Best,

mitsudome-r

The document generally looks good. I made few suggestions.

docs/contributing/coding-guidelines/ros-nodes/topic-message-handling/index.md

…ndling/index.md Co-authored-by: Ryohsuke Mitsudome <43976834+mitsudome-r@users.noreply.github.com>

Signed-off-by: ohsawa1204 <ohsawa.12.04@gmail.com>

mitsudome-r · 2024-05-17T07:20:30Z

@ohsawa1204 FYI, I have manually approved DCO check for this PR, but please sign-off your commits when you create a PR to Autoware repositories in the future. (for example with git commit -s)

takam5f2

@ohsawa1204
Thank you for your work.

ohsawa1204 · 2024-05-17T08:08:40Z

@ohsawa1204 FYI, I have manually approved DCO check for this PR, but please sign-off your commits when you create a PR to Autoware repositories in the future. (for example with git commit -s)

@mitsudome-r
I'm sorry for the inconvenience.
I will do so in the future.

ohsawa1204 · 2024-05-17T08:11:18Z

@ohsawa1204 Thank you for your work.

@takam5f2
Thank you for your time.
Thanks to you.

ohsawa1204 and others added 5 commits April 17, 2024 18:25

doc:change 1

2131301

Signed-off-by: ohsawa1204 <ohsawa.12.04@gmail.com>

doc:change 2

093bfa7

Signed-off-by: ohsawa1204 <ohsawa.12.04@gmail.com>

doc:change 3

6e0f248

Signed-off-by: ohsawa1204 <ohsawa.12.04@gmail.com>

doc:change 4

ff3014d

Signed-off-by: ohsawa1204 <ohsawa.12.04@gmail.com>

style(pre-commit): autofix

2609785

ohsawa1204 marked this pull request as draft April 30, 2024 05:52

ohsawa1204 changed the title ~~Add coding guideline about topic message handling~~ feat: add coding guideline about topic message handling Apr 30, 2024

ohsawa1204 and others added 2 commits April 30, 2024 15:15

doc:change 5

54f31e8

Signed-off-by: ohsawa1204 <ohsawa.12.04@gmail.com>

Merge branch 'main' into test-add-callback-reduction-guidelines

cde9abf

ohsawa1204 marked this pull request as ready for review April 30, 2024 06:19

ohsawa1204 marked this pull request as draft April 30, 2024 06:19

ohsawa1204 marked this pull request as ready for review April 30, 2024 06:34

takam5f2 assigned ohsawa1204 Apr 30, 2024

takam5f2 added the tag:deploy-docs Mark for deploy-docs action generation. (used-by-ci) label Apr 30, 2024

docs(topic-message-handling): create page structure using .pages

cabe89b

Signed-off-by: Takayuki AKAMINE <takayuki.akamine@tier4.jp>

takam5f2 and others added 3 commits May 1, 2024 11:04

docs(topic-message-handling): fix missing links

13bd800

Signed-off-by: Takayuki AKAMINE <takayuki.akamine@tier4.jp>

Merge pull request #1 from takam5f2/create-page-structure-using-.pages

418c2fa

docs(topic-message-handling): create page structure using .pages

docs(topic-message-handling): index -> index.md in 02-supp-waitset.md

f38d7a0

Signed-off-by: ohsawa1204 <ohsawa.12.04@gmail.com>

docs(topic-message-handling): correct misspelled words

7b36ae0

Signed-off-by: ohsawa1204 <ohsawa.12.04@gmail.com>

takam5f2 requested changes May 1, 2024

View reviewed changes

takam5f2 requested changes May 2, 2024

View reviewed changes

ohsawa1204 and others added 5 commits May 2, 2024 15:18

Update docs/contributing/coding-guidelines/ros-nodes/topic-message-ha…

136ab2d

…ndling/index.md Co-authored-by: Takayuki AKAMINE <38586589+takam5f2@users.noreply.github.com>

Update docs/contributing/coding-guidelines/ros-nodes/topic-message-ha…

8fa4990

…ndling/index.md Co-authored-by: Takayuki AKAMINE <38586589+takam5f2@users.noreply.github.com>

Update docs/contributing/coding-guidelines/ros-nodes/topic-message-ha…

554b359

…ndling/index.md Co-authored-by: Takayuki AKAMINE <38586589+takam5f2@users.noreply.github.com>

Update docs/contributing/coding-guidelines/ros-nodes/topic-message-ha…

cba9ec8

…ndling/index.md Co-authored-by: Takayuki AKAMINE <38586589+takam5f2@users.noreply.github.com>

Update docs/contributing/coding-guidelines/ros-nodes/topic-message-ha…

564901a

…ndling/index.md Co-authored-by: Takayuki AKAMINE <38586589+takam5f2@users.noreply.github.com>

ohsawa1204 and others added 7 commits May 14, 2024 11:55

Update docs/contributing/coding-guidelines/ros-nodes/topic-message-ha…

71d093a

…ndling/02-supp-wait_set.md Co-authored-by: Takayuki AKAMINE <38586589+takam5f2@users.noreply.github.com>

Update docs/contributing/coding-guidelines/ros-nodes/topic-message-ha…

f9a9333

…ndling/02-supp-wait_set.md Co-authored-by: Takayuki AKAMINE <38586589+takam5f2@users.noreply.github.com>

Update docs/contributing/coding-guidelines/ros-nodes/topic-message-ha…

5c5cab1

…ndling/02-supp-wait_set.md Co-authored-by: Takayuki AKAMINE <38586589+takam5f2@users.noreply.github.com>

Update docs/contributing/coding-guidelines/ros-nodes/topic-message-ha…

2ba7162

…ndling/02-supp-wait_set.md Co-authored-by: Takayuki AKAMINE <38586589+takam5f2@users.noreply.github.com>

Update docs/contributing/coding-guidelines/ros-nodes/topic-message-ha…

f30f5d8

…ndling/02-supp-wait_set.md Co-authored-by: Takayuki AKAMINE <38586589+takam5f2@users.noreply.github.com>

Update docs/contributing/coding-guidelines/ros-nodes/topic-message-ha…

fd035ab

…ndling/02-supp-wait_set.md Co-authored-by: Takayuki AKAMINE <38586589+takam5f2@users.noreply.github.com>

style(pre-commit): autofix

78609e0

takam5f2 reviewed May 14, 2024

View reviewed changes

docs/contributing/coding-guidelines/ros-nodes/topic-message-handling/index.md Outdated Show resolved Hide resolved

Update docs/contributing/coding-guidelines/ros-nodes/topic-message-ha…

08865bc

…ndling/index.md Co-authored-by: Takayuki AKAMINE <38586589+takam5f2@users.noreply.github.com>

takam5f2 reviewed May 14, 2024

View reviewed changes

docs/contributing/coding-guidelines/ros-nodes/topic-message-handling/.pages Outdated Show resolved Hide resolved

pre-commit-ci bot and others added 3 commits May 14, 2024 05:13

style(pre-commit): autofix

16c064b

docs(topic-message-handling): some fixes

1740112

Signed-off-by: ohsawa1204 <ohsawa.12.04@gmail.com>

Merge branch 'main' into test-add-callback-reduction-guidelines

f7b6b0e

takam5f2 reviewed May 14, 2024

View reviewed changes

takam5f2 requested a review from mitsudome-r May 14, 2024 06:42

mitsudome-r reviewed May 16, 2024

View reviewed changes

docs/contributing/coding-guidelines/ros-nodes/topic-message-handling/index.md Outdated Show resolved Hide resolved

docs/contributing/coding-guidelines/ros-nodes/topic-message-handling/index.md Show resolved Hide resolved

ohsawa1204 and others added 5 commits May 16, 2024 15:02

Update docs/contributing/coding-guidelines/ros-nodes/topic-message-ha…

a9381c9

…ndling/index.md Co-authored-by: Ryohsuke Mitsudome <43976834+mitsudome-r@users.noreply.github.com>

docs(topic-message-handling): corrected as noted by mitsudome-r

7b98baa

Signed-off-by: ohsawa1204 <ohsawa.12.04@gmail.com>

style(pre-commit): autofix

d42c75e

docs(topic-message-handling): minor change

a7bf42d

Signed-off-by: ohsawa1204 <ohsawa.12.04@gmail.com>

style(pre-commit): autofix

47eaf3e

mitsudome-r approved these changes May 17, 2024

View reviewed changes

takam5f2 approved these changes May 17, 2024

View reviewed changes

ohsawa1204 merged commit cefcc1a into autowarefoundation:main May 17, 2024
9 of 10 checks passed

tier4-autoware-public-bot bot mentioned this pull request May 18, 2024

chore: sync upstream tier4/autoware-documentation#43

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add coding guideline about topic message handling #543

feat: add coding guideline about topic message handling #543

ohsawa1204 commented Apr 30, 2024 •

edited

Loading

github-actions bot commented Apr 30, 2024 •

edited

Loading

takam5f2 commented May 1, 2024

ohsawa1204 commented May 1, 2024

takam5f2 left a comment

takam5f2 left a comment

takam5f2 left a comment

takam5f2 left a comment

ohsawa1204 commented May 14, 2024

takam5f2 commented May 14, 2024

mitsudome-r left a comment

mitsudome-r commented May 17, 2024

takam5f2 left a comment

ohsawa1204 commented May 17, 2024

ohsawa1204 commented May 17, 2024

feat: add coding guideline about topic message handling #543

feat: add coding guideline about topic message handling #543

Conversation

ohsawa1204 commented Apr 30, 2024 • edited Loading

Description

Pre-review checklist for the PR author

In-review checklist for the PR reviewers

Post-review checklist for the PR author

github-actions bot commented Apr 30, 2024 • edited Loading

takam5f2 commented May 1, 2024

ohsawa1204 commented May 1, 2024

takam5f2 left a comment

Choose a reason for hiding this comment

takam5f2 left a comment

Choose a reason for hiding this comment

takam5f2 left a comment

Choose a reason for hiding this comment

takam5f2 left a comment

Choose a reason for hiding this comment

ohsawa1204 commented May 14, 2024

takam5f2 commented May 14, 2024

mitsudome-r left a comment

Choose a reason for hiding this comment

mitsudome-r commented May 17, 2024

takam5f2 left a comment

Choose a reason for hiding this comment

ohsawa1204 commented May 17, 2024

ohsawa1204 commented May 17, 2024

ohsawa1204 commented Apr 30, 2024 •

edited

Loading

github-actions bot commented Apr 30, 2024 •

edited

Loading