Merge pull request #11 from tier4/sync-upstream

chore: sync upstream

.github/sync-files.yaml

@@ -4,6 +4,12 @@
     - source: CONTRIBUTING.md
     - source: DISCLAIMER.md
     - source: LICENSE
+    - source: .github/ISSUE_TEMPLATE/bug.yaml
+    - source: .github/ISSUE_TEMPLATE/config.yml
+    - source: .github/ISSUE_TEMPLATE/task.yaml
+    - source: .github/PULL_REQUEST_TEMPLATE.md
+    - source: .github/PULL_REQUEST_TEMPLATE/small-change.md
+    - source: .github/PULL_REQUEST_TEMPLATE/standard-change.md
     - source: .github/dependabot.yaml
     - source: .github/workflows/pre-commit.yaml
     - source: .github/workflows/pre-commit-optional.yaml
@@ -15,3 +21,7 @@
     - source: .prettierignore
     - source: .prettierrc.yaml
     - source: .yamllint.yaml
+
+- repository: autowarefoundation/autoware_common
+  files:
+    - source: .github/workflows/sync-files.yaml

.github/workflows/deploy-docs.yaml

@@ -38,4 +38,4 @@ jobs:
         uses: autowarefoundation/autoware-github-actions/deploy-docs@v1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          latest: ${{ github.ref_name == github.event.repository.default_branch }}
+          latest: ${{ github.event_name != 'pull_request_target' && github.ref_name == github.event.repository.default_branch }}

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][mozilla coc].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][faq]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[mozilla coc]: https://github.com/mozilla/diversity
+[faq]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# Contributing
+
+See <https://autowarefoundation.github.io/autoware-documentation/main/contributing/>.

DISCLAIMER.md

@@ -0,0 +1,46 @@
+DISCLAIMER
+
+“Autoware” will be provided by The Autoware Foundation under the Apache License 2.0.
+This “DISCLAIMER” will be applied to all users of Autoware (a “User” or “Users”) with
+the Apache License 2.0 and Users shall hereby approve and acknowledge all the contents
+specified in this disclaimer below and will be deemed to consent to this
+disclaimer without any objection upon utilizing or downloading Autoware.
+
+Disclaimer and Waiver of Warranties
+
+1. AUTOWARE FOUNDATION MAKES NO REPRESENTATION OR WARRANTY OF ANY KIND,
+   EXPRESS OR IMPLIED, WITH RESPECT TO PROVIDING AUTOWARE (the “Service”)
+   including but not limited to any representation or warranty (i) of fitness or
+   suitability for a particular purpose contemplated by the Users, (ii) of the
+   expected functions, commercial value, accuracy, or usefulness of the Service,
+   (iii) that the use by the Users of the Service complies with the laws and
+   regulations applicable to the Users or any internal rules established by
+   industrial organizations, (iv) that the Service will be free of interruption or
+   defects, (v) of the non-infringement of any third party's right and (vi) the
+   accuracy of the content of the Services and the software itself.
+
+2. The Autoware Foundation shall not be liable for any damage incurred by the
+   User that are attributable to the Autoware Foundation for any reasons
+   whatsoever. UNDER NO CIRCUMSTANCES SHALL THE AUTOWARE FOUNDATION BE LIABLE FOR
+   INCIDENTAL, INDIRECT, SPECIAL OR FUTURE DAMAGES OR LOSS OF PROFITS.
+
+3. A User shall be entirely responsible for the content posted by the User and
+   its use of any content of the Service or the Website. If the User is held
+   responsible in a civil action such as a claim for damages or even in a criminal
+   case, the Autoware Foundation and member companies, governments and academic &
+   non-profit organizations and their directors, officers, employees and agents
+   (collectively, the “Indemnified Parties”) shall be completely discharged from
+   any rights or assertions the User may have against the Indemnified Parties, or
+   from any legal action, litigation or similar procedures.
+
+Indemnity
+
+A User shall indemnify and hold the Indemnified Parties harmless from any of
+their damages, losses, liabilities, costs or expenses (including attorneys'
+fees or criminal compensation), or any claims or demands made against the
+Indemnified Parties by any third party, due to or arising out of, or in
+connection with utilizing Autoware (including the representations and
+warranties), the violation of applicable Product Liability Law of each country
+(including criminal case) or violation of any applicable laws by the Users, or
+the content posted by the User or its use of any content of the Service or the
+Website.

NOTICE

@@ -0,0 +1,5 @@
+autowarefoundation/autoware-documentation
+Copyright 2021 The Autoware Foundation
+
+This product includes software developed at
+The Autoware Foundation (https://www.autoware.org/).

docs/contributing/.pages

@@ -1,5 +1,6 @@
 nav:
   - index.md
+  - license.md
   - coding-guidelines
   - testing-guidelines
   - documentation-guidelines

docs/contributing/index.md

@@ -1,15 +1,69 @@
 # Contributing
 
-!!! warning
+This page explains how to contribute to Autoware.
 
-    Under Construction
+First, conform to the [Code of conduct](#contribution-workflows) section for the general manners in contributions.
+
+See the [Contribution workflows](#contribution-workflows) section for the workflows.  
+Also, make sure the contribution is in line with the following guidelines:
+
+- [Coding guidelines](coding-guidelines/index.md): for contributing source code
+- [Testing guidelines](testing-guidelines/index.md): for contributing tests
+- [Documentation guidelines](documentation-guidelines/index.md): for contributing documents
+- [Pull request guidelines](pull-request-guidelines/index.md): for submitting pull requests
+- [Discussion guidelines](discussion-guidelines/index.md): for discussing with other contributors
+- [Support guidelines](../help/support-guidelines.md): for finding the right channel when you need help
+
+It is recommended to read the [Contributing pages in ROS 2 Docs](https://docs.ros.org/en/rolling/Contributing.html) as well because Autoware's guidelines generally depend on them.
+
+For general information about OSS contributions, [Open Source Guides](https://opensource.guide/) by GitHub is a good resource.
+
+!!!info
+
+    If you want to make changes to the guidelines in this documentation site, you can open a new discussion thread and propose it.
+
+## Code of conduct
+
+We welcome contributions from everyone.  
+To ensure our community stays open and healthy, we adhere to the [Contributor Covenant](https://www.contributor-covenant.org/), a widely used [code of conduct](https://github.com/autowarefoundation/autoware/blob/main/CODE_OF_CONDUCT.md) adopted by many other communities listed [here](https://www.contributor-covenant.org/adopters/).
+
+Everyone participating in the Autoware community is expected to follow the code of conduct.  
+If someone in the community happens to be violating these terms, let the maintainers know, and we will address it as soon as possible.
+
+!!!warning
+
+    Note that contributions that ignore guidelines are not contributions but nuisances.
 
 ## Contribution workflows
 
-### Issues
+There are several types of contributions and the workflows differ between the types.
+See the description for your contribution type.
 
 ### Discussions
 
-### Small pull requests
+You can contribute to Autoware by facilitating discussions:
+
+- Find a bug and open a new issue.
+- Propose an idea of features that will enhance Autoware.
+- Join an existing discussion and express your opinion.
+- Organize discussions for other contributors.
+- Answer questions and support other contributors.
+
+See our [support guidelines](../help/support-guidelines.md) for the detailed steps.
+
+### Pull requests
+
+You can submit a pull request directly (without opening an issue) if it is small like the following:
+
+- Update a small part of documents.
+- Fix spelling mistakes.
+- Fix CI failures.
+- Fix warnings detected by compilers or analysis tools.
+- Make small changes to a single package.
+
+Otherwise, create an issue or a discussion thread before submitting a pull request and discuss the approach with maintainers.
+
+Also, regardless of the size of your pull request, follow the pull request template of the target repository.
 
-### Large pull requests
+See our [pull request guidelines](pull-request-guidelines/index.md) for the detailed steps.  
+See [License](license.md) for the license notations.

docs/contributing/license.md

@@ -0,0 +1,44 @@
+# License
+
+Autoware is licensed under Apache License 2.0.
+Thus all contributions will be licensed as such as per clause 5 of the Apache License 2.0:
+
+```text
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+```
+
+Here is an example copyright header to add to the top of a new file:
+
+```text
+Copyright [first year of contribution] The Autoware Contributors
+SPDX-License-Identifier: Apache-2.0
+```
+
+We don't write copyright notations of each contributor here.
+Instead, we place them in the `NOTICE` file like the following.
+
+```text
+This product includes code developed by [company name].
+Copyright [first year of contribution] [company name]
+```
+
+Let us know if your legal department has a special request for the copyright notation.
+
+Currently, the old formats explained [here](https://gitlab.com/autowarefoundation/autoware.auto/AutowareAuto/-/blob/87c5e5880a18068116dd886ad56e1bfc29e694c4/CONTRIBUTING.md) are also acceptable.
+Those old formats can be replaced by this new format if the original authors agree.  
+Note that we won't write their copyrights to the `NOTICE` file unless they agree with the new format.
+
+References:
+
+- <https://opensource.google/docs/copyright/#the-year>
+- <https://www.linuxfoundation.org/blog/copyright-notices-in-open-source-software-projects/>
+- <https://www.apache.org/licenses/LICENSE-2.0>
+- <https://www.apache.org/legal/src-headers.html>
+- <https://www.apache.org/foundation/license-faq.html>
+- <https://infra.apache.org/licensing-howto.html>

docs/contributing/pull-request-guidelines/.pages

@@ -1,2 +1,4 @@
 nav:
   - index.md
+  - commit-guidelines.md
+  - review-tips.md