How to contribute to MMAction2¶

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

Fixes (typo, bugs)
New features and components
Add documentation or translate the documentation into other languages
Add new project (Recommended) about video understanding algorithm with less restriction, refer to here for details

Workflow¶

Fork and pull the latest mmaction2
Checkout a new branch with a meaningful name (do not use main branch for PRs)
Commit your changes
Create a PR

Note

If you plan to add some new features that involve large changes, it is encouraged to open an issue for discussion first.
If you are the author of some papers and would like to include your method to mmaction2, please contact us. We will much appreciate your contribution.

Code style¶

Python¶

We adopt PEP8 as the preferred code style.

We use the following tools for linting and formatting:

flake8: linter
yapf: formatter
isort: sort imports
codespell: A Python utility to fix common misspellings in text files.
mdformat: Mdformat is an opinionated Markdown formatter that can be used to enforce a consistent style in Markdown files.
docformatter: A formatter to format docstring.

Style configurations of yapf and isort can be found in setup.cfg.

We use pre-commit hook that checks and formats for flake8, yapf, isort, trailing whitespaces, markdown files, fixes end-of-files, double-quoted-strings, python-encoding-pragma, mixed-line-ending, sorts requirments.txt automatically on every commit. The config for a pre-commit hook is stored in .pre-commit-config.

After you clone the repository, you will need to install initialize pre-commit hook.

pip install -U pre-commit

From the repository folder

pre-commit install

After this on every commit check code linters and formatter will be enforced.

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.