openvqa/docs/_source/advanced/contributing.md

Contributing to OpenVQA

All kinds of contributions are welcome, including but not limited to the following.

• Fixes (typo, bugs)
• New features and components

Workflow

1. fork and pull the latest version of OpenVQA
2. checkout a new branch (do not use master branch for PRs)
3. commit your changes
4. create a PR

Code style

Python

We adopt PEP8 as the preferred code style. We use flake8 as the linter and yapf as the formatter. Please upgrade to the latest yapf (>=0.27.0) and refer to the configuration.

Before you create a PR, make sure that your code lints and is formatted by yapf.

C++ and CUDA

We follow the Google C++ Style Guide.