autoware-documentation icon indicating copy to clipboard operation
autoware-documentation copied to clipboard

feat: add parameter description

Open takayuki5168 opened this issue 2 years ago • 3 comments

Signed-off-by: Takayuki Murooka [email protected]

Related links

https://github.com/autowarefoundation/autoware_launch/issues/66

Description

We will add a config/ directory in the autoware_launch package soon. In this PR, I added the document about what kind of parameters we have and how to manage them.

Pre-review checklist for the PR author

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

In-review checklist for the PR reviewers

The Reviewers must check the checkboxes below before approval.

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.

takayuki5168 avatar Jul 26 '22 04:07 takayuki5168

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

  • https://autowarefoundation.github.io/autoware-documentation/pr-171/contributing/coding-guidelines/ros-nodes/parameters/

github-actions[bot] avatar Jul 26 '22 04:07 github-actions[bot]

@kenji-miyake This is a WIP PR. Could you have a brief look at this PR? Does this PR look good so far?

takayuki5168 avatar Jul 26 '22 04:07 takayuki5168

@takayuki5168 Could you write a bit more concrete description? :bow:

kenji-miyake avatar Jul 26 '22 06:07 kenji-miyake

@kenji-miyake Can I merge this PR if you get your approval even though the parameter management described in this doc has not been used in autoware.

I wrote like this to notice that this is a proposal document for now. image

takayuki5168 avatar Sep 27 '22 02:09 takayuki5168

@takayuki5168 Hmm, I think in that case we should discuss and adopt it. What is the blocker for using the parameter management method? Anyway, I'll take a look at this PR this week in more detail.

kenji-miyake avatar Sep 27 '22 03:09 kenji-miyake

(I'm sorry for my late reply.) I've talked to @takayuki5168. We'll organize the management system of config files first, and merge this document at the same time.

The development policy is already agreed in https://github.com/autowarefoundation/autoware_launch/issues/66.

kenji-miyake avatar Oct 19 '22 12:10 kenji-miyake

This pull request has been automatically marked as stale because it has not had recent activity.

stale[bot] avatar Dec 18 '22 12:12 stale[bot]