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

OSCHINA-MIRROR/mirrors-baserow

Клонировать/Скачать
code-quality.md 3.8 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
Отправлено 26.06.2025 16:02 92285f5

Качество кода

Качество кода очень важно. Именно поэтому у нас есть линтеры, юнит-тесты, документация API, документация в коде, документация для разработчиков, модульный код, и мы вложили много усилий в архитектуру как бэкенда, так и веб-фронтенда.

Запуск линтеров и тестов

Если у вас настроена разработка окружение, вы можете легко запустить линтеры. И бэкенд, и веб-фронтенд имеют файлы make, чтобы помочь вам.

  • make format (бэкенд): автоматическое форматирование всего Python-кода с помощью black.
  • make lint (бэкенд): весь Python-код будет проверен с помощью flake8 и black.
  • make eslint (веб-фронтенд): весь JavaScript-код будет проверен с помощью eslint.
  • make stylelint (веб-фронтенд): весь SCSS-код будет проверен с помощью stylelint.

Запуск тестов

Также есть команды для легкого запуска тестов.

  • make test (бэкенд): весь бэкендный Python-код будет протестирован с помощью pytest.
  • make jest (веб-фронтенд): весь веб-фронтендный код будет протестирован с помощью jest.

Непрерывная интеграция

Чтобы убедиться, что ничего не было упущено во время разработки, у нас также есть конвейер непрерывной интеграции, который запускается каждый раз при пуше ветки. Все команды, описанные выше, будут выполнены в изолированной среде. Для повышения скорости они разделены на этапы линтинга и тестирования. Не допускается слияние ветки, если один из этих заданий завершился неудачно.

Конвейер также имеет задание сборки. В ходе этого задания шаблон плагина Baserow будет установлен как зависимость, чтобы убедиться, что это все еще работает.

Запуск GitLab runners локально

Если вы хотите проверить, пройдет ли ваше задание до того, как вы запушите ветку, вы также можете запустить их локально. Убедитесь, что вы установили GitLab runner, следуя инструкциям на https://docs.gitlab.com/runner/install/. После этого вы должны быть able to run the gitlab-runner --help команду в терминале. Задания можно выполнить, запустив команды ниже.

Убедитесь, что вы находитесь в корне репозитория Baserow и что все изменения были зафиксированы, так как runner проверяет текущую ветку.

  • gitlab-runner exec docker web-frontend-eslint
  • gitlab-runner exec docker web-frontend-stylelint
  • gitlab-runner exec docker web-frontend-test
  • gitlab-runner exec docker backend-flake8
  • gitlab-runner exec docker backend-pytest
  • gitlab-runner exec docker backend-setup

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

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

1
https://api.gitlife.ru/oschina-mirror/mirrors-baserow.git
git@api.gitlife.ru:oschina-mirror/mirrors-baserow.git
oschina-mirror
mirrors-baserow
mirrors-baserow
develop