Внесение вклада в OpenMMLab

Все виды вклада приветствуются, включая, но не ограничиваясь следующими:

• Устранение опечаток или ошибок
• Добавление документации или перевод документации на другие языки
• Добавление новых функций и компонентов

Процесс работы

1. Создайте форк и получите последнюю версию репозитория OpenMMLab (MMClassification)
2. Выполните команду для создания новой ветки (не используйте основную ветку master для PR)
3. Подтвердите свои изменения
4. Создайте запрос на слияние (PR)

Если вы планируете добавить новые функции, которые требуют значительных изменений, рекомендуется сначала открыть issue для обсуждения.

Стиль кода

Python

Мы используем PEP8 как предпочитаемый стиль кода.

Для линтинга и форматирования мы используем следующие инструменты:

• flake8: Обёртка вокруг некоторых инструментов для линтинга.
• isort: Утилита Python для сортировки импортов.
• yapf: Форматтер для файлов Python.
• codespell: Утилита Python для исправления распространённых опечаток в текстовых файлах.
• mdformat: Mdformat — это мнемонический форматтер Markdown, который можно использовать для обеспечения согласованного стиля в файлах Markdown.
• docformatter: Форматтер для форматирования строки документации.Конфигурация стиля находится в setup.cfg.

Мы используем pre-commit hook, который проверяет и форматирует для flake8, yapf, isort, пробелов в конце строк, файлов Markdown, фиксирует концы файлов, двойные кавычки, pragma кодировки Python, смешанные окончания строк, автоматически сортирует requirements.txt при каждом коммите. Конфигурация pre-commit hook хранится в .pre-commit-config.

После клонирования репозитория вам потребуется установить и инициализировать pre-commit hook.

pip install -U pre-commit

Из папки репозитория выполните:

pre-commit install

После этого при каждом коммите будут применяться проверки линтеров и форматтера.

Перед созданием PR убедитесь, что ваш код прошёл проверку линтерами и был сформатирован yapf.

C++ и CUDA

Мы следуем Google C++ Style Guide.