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

docs: update README #36

Merged
merged 11 commits into from
Jun 14, 2022
Merged

Conversation

shmpwk
Copy link
Contributor

@shmpwk shmpwk commented May 27, 2022

Signed-off-by: Shumpei Wakabayashi [email protected]

Description

Update README with more concrete information.
Related PR: autowarefoundation/autoware.universe#970 (comment)

The README explanation is based on https://github.com/autowarefoundation/autoware which says

Main repository for high-quality, stable ROS packages for Autonomous Driving.
Based on Autoware.Auto and Autoware.Universe.

I mainly changed the 2nd line because IMO

  • relationship of AutowareAuto is ambiguous
  • relationship of universe should be described.

The universe explanation is based on https://github.com/autowarefoundation/autoware.

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 PR 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.

Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

Initial review. If people can spare the time, I would appreciate feedback around the first suggested change, along with the idea of adding an explanation to explain the current situation (developing bus ODD in Universe, will move over to Core at a later point). 🙇🏾

@soblin soblin self-assigned this May 27, 2022
@shmpwk shmpwk requested a review from a user June 1, 2022 06:51
ghost
ghost previously approved these changes Jun 1, 2022
@shmpwk shmpwk dismissed ghost ’s stale review via 7185679 June 1, 2022 08:42
@shmpwk shmpwk force-pushed the docs/update-README branch 2 times, most recently from 7185679 to 9547354 Compare June 1, 2022 08:43
@kenji-miyake
Copy link
Contributor

Is it okay if there is no explanation about the transition plan? I guess people would wonder why this repository is empty.

@shmpwk
Copy link
Contributor Author

shmpwk commented Jun 1, 2022

Right, add porting plan by 682af3d.

@kminoda kminoda removed their assignment Jun 1, 2022
kenji-miyake
kenji-miyake previously approved these changes Jun 1, 2022
Copy link
Contributor

@kenji-miyake kenji-miyake left a comment

Choose a reason for hiding this comment

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

LGTM. @mitsudome-r @xmfcx @BonoloAWF Could you briefly take a look at this, please? 🙏

Copy link

@BonoloAWF BonoloAWF left a comment

Choose a reason for hiding this comment

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

An Autoware repository that contains a basic set of high-quality, stable ROS packages for autonomous driving.

It is worthwhile adding one or two sentences explaining how this autoware.core repository relates to autoware.universe repository

@shmpwk
Copy link
Contributor Author

shmpwk commented Jun 6, 2022

@shmpwk
Copy link
Contributor Author

shmpwk commented Jun 14, 2022

@LalithVipulananthan @mitsudome-r @xmfcx @BonoloAWF

Could I merge this? If I can get one more approval, I'd like to merge this.

@ghost
Copy link

ghost commented Jun 14, 2022

@shmpwk Apologies for missing this. I did want to rearrange some of the content in this README. If you can wait just a short while, I will review with my suggested changes before 5pm today.

Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

@shmpwk Apologies for the delay! Please review my suggestions and let me know what you think. 🙏🏾

ghost
ghost previously approved these changes Jun 14, 2022
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

LGTM, although unfortunately I do not have write access for this repo. @kenji-miyake, could you approve this PR again please?

shmpwk and others added 8 commits June 14, 2022 17:25
Signed-off-by: Shumpei Wakabayashi <[email protected]>
Co-authored-by: Lalith Vipulananthan <[email protected]>
Signed-off-by: Shumpei Wakabayashi <[email protected]>
Co-authored-by: Lalith Vipulananthan <[email protected]>
Signed-off-by: Shumpei Wakabayashi <[email protected]>
Signed-off-by: Shumpei Wakabayashi <[email protected]>
Signed-off-by: Shumpei Wakabayashi <[email protected]>
Signed-off-by: Shumpei Wakabayashi <[email protected]>
Co-authored-by: Lalith Vipulananthan <[email protected]>
Signed-off-by: Shumpei Wakabayashi <[email protected]>
Co-authored-by: Lalith Vipulananthan <[email protected]>
Signed-off-by: Shumpei Wakabayashi <[email protected]>
pre-commit-ci bot added 2 commits June 14, 2022 17:25
Signed-off-by: Shumpei Wakabayashi <[email protected]>
updates:
- [github.com/pre-commit/pre-commit-hooks: v4.2.0 → v4.3.0](pre-commit/pre-commit-hooks@v4.2.0...v4.3.0)
- [github.com/scop/pre-commit-shfmt: v3.5.0-1 → v3.5.1-1](scop/pre-commit-shfmt@v3.5.0-1...v3.5.1-1)
- [github.com/pre-commit/mirrors-clang-format: v14.0.3 → v14.0.4-1](pre-commit/mirrors-clang-format@v14.0.3...v14.0.4-1)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Signed-off-by: Shumpei Wakabayashi <[email protected]>
@shmpwk shmpwk dismissed ghost ’s stale review via a9d25a0 June 14, 2022 08:25
@shmpwk shmpwk force-pushed the docs/update-README branch from 4bf10f3 to a9d25a0 Compare June 14, 2022 08:25
@shmpwk shmpwk requested a review from kenji-miyake June 14, 2022 08:26
@shmpwk
Copy link
Contributor Author

shmpwk commented Jun 14, 2022

Thank you! Could you merge this @kenji-miyake since I don't have right to merge this.

@kenji-miyake kenji-miyake merged commit 9caa3bb into autowarefoundation:main Jun 14, 2022
@shmpwk shmpwk deleted the docs/update-README branch June 14, 2022 08:30
mitsudome-r pushed a commit to mitsudome-r/autoware.core that referenced this pull request Nov 13, 2024
Signed-off-by: GitHub <[email protected]>

Co-authored-by: kenji-miyake <[email protected]>
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.

5 participants