From 04544fe878dfa070ffcdf9477159a11382c9ec5c Mon Sep 17 00:00:00 2001 From: Lalith Vipulananthan <63835446+LalithVipulananthan@users.noreply.github.com> Date: Wed, 23 Mar 2022 19:33:06 +0900 Subject: [PATCH] Organization profile first draft (#1) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Organization profile first draft A first pass at an organization profile for the AWF * Added brief description of each repository Brief description of each repository was taken from an older version of the autoware repository's README, with some additional minor editing. Signed-off-by: Lalith Vipulananthan * Apply suggestions from code review Co-authored-by: Lalith Vipulananthan <63835446+LalithVipulananthan@users.noreply.github.com> * Apply suggestions from code review Batch applying suggestions Co-authored-by: M. Fatih Cırıt * Updated top image Changelist: - Added a link to the Autoware Foundation homepage at the top where the AWF is first mentioned - Minor formatting changes around the Contribution Guidelines section - Moved the Autoware Foundation link to the Useful resources section and removed the Appendix section as it seemed redundant with just the one link there * Updated repository overview * Add Discord invite badge Co-authored-by: M. Fatih Cırıt Co-authored-by: M. Fatih Cırıt --- profile/README.md | 44 +++++++++++++++++++++++++++++++++++--------- 1 file changed, 35 insertions(+), 9 deletions(-) diff --git a/profile/README.md b/profile/README.md index 596fd67..5c31e50 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,12 +1,38 @@ -## Hi there 👋 +## Welcome to the Autoware Foundation! 👋 +![Autoware_RViz](https://user-images.githubusercontent.com/63835446/158918717-58d6deaf-93fb-47f9-891d-e242b02cba7b.png) - +### Repository overview +- [autowarefoundation/autoware](https://github.com/autowarefoundation/autoware) + - Meta-repository containing `.repos` files to construct an Autoware workspace. + - It is anticipated that this repository will be frequently forked by users, and so it contains minimal information to avoid unnecessary differences. +- [autowarefoundation/autoware_common](https://github.com/autowarefoundation/autoware_common) + - Library/utility type repository containing commonly referenced ROS packages. + - These packages were moved to a separate repository in order to reduce CI execution time +- [autowarefoundation/autoware.core](https://github.com/autowarefoundation/autoware.core) + - Main repository for high-quality, stable ROS packages for Autonomous Driving. + - Based on [Autoware.Auto](https://gitlab.com/autowarefoundation/autoware.auto/AutowareAuto) and [Autoware.Universe](https://github.com/autowarefoundation/autoware.universe). +- [autowarefoundation/autoware.universe](https://github.com/autowarefoundation/autoware.universe) + - Repository for experimental, cutting-edge ROS packages for Autonomous Driving. + - Autoware Universe was created to make it easier for researchers and developers to extend the functionality of Autoware Core +- [autowarefoundation/autoware_launch](https://github.com/autowarefoundation/autoware_launch) + - Launch configuration repository containing node configurations and their parameters. +- [autowarefoundation/autoware-github-actions](https://github.com/autowarefoundation/autoware-github-actions) + - Contains [reusable GitHub Actions workflows](https://docs.github.com/ja/actions/learn-github-actions/reusing-workflows) used by multiple repositories for CI. + - Utilizes the [DRY](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself) concept. +- [autowarefoundation/autoware-documentation](https://github.com/autowarefoundation/autoware-documentation) + - Documentation repository for Autoware users and developers. + - Since Autoware Core/Universe has multiple repositories, a central documentation repository is important to make information accessible from a single place. + +### Contribution guidelines +- [There is no formal process to become a contributor](https://github.com/autowarefoundation/autoware-projects/wiki#contributors) - you can comment on any [existing issues](https://github.com/autowarefoundation/autoware.universe/issues) or make a pull request on any Autoware repository! + - Make sure to follow the [Contribution Guidelines](https://autowarefoundation.github.io/autoware-documentation/main/contributing/). + - Take a look at Autoware's [various working groups](https://github.com/autowarefoundation/autoware-projects/wiki#working-group-list) to gain an understanding of any work in progress and to see how projects are managed. +- If you have any questions or ideas, feel free to start a discussion on [GitHub Discussions in autowarefoundation/autoware](https://github.com/autowarefoundation/autoware/discussions). + +### Useful resources +- [Autoware documentation](https://autowarefoundation.github.io/autoware-documentation/main/) (also [open source](https://github.com/autowarefoundation/autoware-documentation)!) +- [Autoware Foundation homepage](https://www.autoware.org/)