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: add an overview of contribution guidelines #43

Merged
merged 12 commits into from
Mar 9, 2022
62 changes: 57 additions & 5 deletions docs/contributing/index.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,67 @@
# Contributing

!!! warning
This page explains how to contribute to Autoware.

Under Construction
First, confirm the [Code of conduct](#contribution-workflows) section for the general manners in contributions.
kenji-miyake marked this conversation as resolved.
Show resolved Hide resolved

See the [Contribution workflows](#contribution-workflows) section for the workflows.
Also, confirm the following our guidelines depending on your situation:
kenji-miyake marked this conversation as resolved.
Show resolved Hide resolved

- [Coding guidelines](coding-guidelines/index.md): when you write source code
- [Testing guidelines](testing-guidelines/index.md): when you write tests
- [Documentation guidelines](documentation-guidelines/index.md): when you write documents
- [Pull request guidelines](pull-request-guidelines/index.md): when you submit pull requests
- [Discussion guidelines](discussion-guidelines/index.md): when you discuss with other contributors
- [Support guidelines](../help/support-guidelines.md): when you need any help
kenji-miyake marked this conversation as resolved.
Show resolved Hide resolved

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 apply a new or different rule, you can open a new discussion thread and propose it.
kenji-miyake marked this conversation as resolved.
Show resolved Hide resolved

## Code of conduct
xmfcx marked this conversation as resolved.
Show resolved Hide resolved

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 discussion so far for others contributors.
kenji-miyake marked this conversation as resolved.
Show resolved Hide resolved
- Answer an question and support other contributors.
kenji-miyake marked this conversation as resolved.
Show resolved Hide resolved

See our [support guidelines](../help/support-guidelines.md) for the detailed steps.

### Pull requests

You can directly submit a pull request if it is small like the following:
kenji-miyake marked this conversation as resolved.
Show resolved Hide resolved

- Update a small part of documents.
- Fix spelling mistakes.
- Fix CI failures.
- Fix warnings detected by compilers or analysis tools.
kenji-miyake marked this conversation as resolved.
Show resolved Hide resolved

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.