1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/monkeycc-mmclassification

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
CONTRIBUTING.md 4.8 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
Отправлено 14.03.2025 03:30 cf393b9

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

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

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

Рабочий процесс

Мы рекомендуем потенциальным участникам следовать этому рабочему процессу при внесении вклада.

  1. Создайте форк и получите последнюю версию репозитория MMPreTrain, следуйте началу работы для установки среды.
  2. Выполните команду для создания новой ветки (не используйте основную или dev ветку для PR)
git checkout -b xxxx # xxxx — это имя новой ветки
  1. Измените связанные файлы, следуя указанному ниже стилю кода
  2. Используйте препрокоммит хук для проверки и форматирования ваших изменений.
  3. Подтвердите ваши изменения
  4. Создайте PR с необходимыми данными

Стиль кода

Python

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

Мы используем следующие инструменты для линтинга и форматирования:- flake8: Обёртка вокруг некоторых инструментов для линтера.

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

Конфигурация стилей yapf и isort находится в setup.cfg.

C++ и CUDA

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

Препрокоммит хук

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

pip install -U pre-commit

Из папки с репозиторием:

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

> Перед созданием pull request убедитесь, что ваш код проходит проверку линтерами и отформатирован yapf.

Опубликовать ( 0 )

Вы можете оставить комментарий после Вход в систему

1
https://api.gitlife.ru/oschina-mirror/monkeycc-mmclassification.git
git@api.gitlife.ru:oschina-mirror/monkeycc-mmclassification.git
oschina-mirror
monkeycc-mmclassification
monkeycc-mmclassification
main