Skip to content

Commit

Permalink
Add contributing guideline for public repository (#275)
Browse files Browse the repository at this point in the history
* Add contributing guideline for public repository

Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>

* Fix CONTRIBUTING.md

Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>

* Apply review comment

Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>
  • Loading branch information
kenji-miyake authored Sep 13, 2021
1 parent 7adaee2 commit 58ad613
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# How to contribute to AutowareArchitectureProposal

Thank you for your interest in improving the AutowareArchitectureProposal repository! As this repository is simply a mirror of a private repository, created to propose a new Autoware reference implementation to the [Autoware Foundation](https://www.autoware.org/), issues and pull requests are not accepted.

If you are interested in developing Autoware, then consider contributing to the [Autoware.Auto project](https://gitlab.com/autowarefoundation/autoware.auto) instead. All Autoware development and user discussion takes place within that repository, and everyone is welcome to create issues and merge requests!

Before making any contributions to the Autoware.Auto project, please make sure to review the [contributor's guide](https://autowarefoundation.gitlab.io/autoware.auto/AutowareAuto/contributors-guide.html), and please refrain from asking questions about the AutowareArchitectureProposal repository via ROS Answers or an Autoware.Auto issue.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,12 @@

[![autoware](https://user-images.githubusercontent.com/8327598/69472442-cca50b00-0ded-11ea-9da0-9e2302aa1061.png)](https://youtu.be/kn2bIU_g0oY)

AutowareArchitectureProposal is a repository to explore and establish the architecture design of Autoware, an autonomous driving software managed by Autoware Foundation.
AutowareArchitectureProposal is a repository to explore and establish the architecture design of Autoware, an autonomous driving software managed by the Autoware Foundation.

> Note:
>
> - As this repository is simply a mirror of a private repository, issues and pull requests are not accepted. Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for more details.
> - In the documentation, some links may appear broken. These links are pointing to internal Tier IV documents, so please ignore them.
## Documentation

Expand Down

0 comments on commit 58ad613

Please sign in to comment.