Skip to content

Latest commit

 

History

History
117 lines (74 loc) · 5.47 KB

commit-style.rus.md

File metadata and controls

117 lines (74 loc) · 5.47 KB

Стиль фиксаций

English | Русский

Стиль фиксаций, принятый в проекте IX-Ray

Обзор

В проекте принят стандарт фиксаций для обеспечения прозрачности и понимания вносимых изменений. Приемлемый стиль фиксаций описан ниже

Общие Правила

  • Сообщения к коммитам должны быть написаны на английском языке
  • Каждое сообщение должно отвечать на вопрос: "Если этот коммит будет применён, он..."
  • Сообщение должно начинаться с глагола в инфинитиве без частицы to
  • Никаких флагов, таких как [Fix], [UPDATE] и т.п., использовать не нужно. Глагол должен чётко описывать выполненное действие
  • Сообщение должно быть кратким, но информативным. При необходимости можно добавить дополнительное описание
  • Первая буква сообщения должна быть заглавной
  • Если вы не уверены, как написать на английском, напишите на своём родном языке, чётко описывая, что вы сделали (избегайте "бреда", мы переведём и доработаем сообщение)

Структура Сообщений

Начальные фиксации

Первоначальное сообщение о фиксации должно быть написано в следующем стиле:

Initial commit

Рабочие фиксации

Обычное сообщение о фиксации должно состоять из одной части и быть построено в соответствии со следующим шаблоном:

<Основное сообщение коммита>

<Дополнительное описание, если необходимо>

Ограничения по длине

  • Максимальная длина заголовка сообщения коммита — 72 символа
  • Каждая строка в дополнительном описании также не должна превышать 72 символа

Правила Написания Сообщений

Формат Заголовка

Сообщение коммита должно начинаться с глагола в инфинитиве, описывающего действие, выполненное в коммите. Примеры:

  • Fix window manager implementation
  • Implement audio output support
  • Remove obsolete configurations
  • Add documentation for API endpoints
  • Optimize rendering pipeline

Особые правила для существительных

Если сообщение включает существительное, важно правильно разместить его, чтобы фраза звучала естественно:

  • Implement new devices support (предпочтительно)
  • Add new gizmo support (предпочтительно)
  • Add support for AMD FSR (нежелательно, используйте структуру выше)
  • Implement support for new devices (нежелательно, переформулируйте как в примерах выше)

Рекомендуется, чтобы основное существительное шло после уточнений, если это возможно, для лучшей читаемости

Примеры корректных сообщений

Однострочные сообщения

  • Fix memory leak in database connector
  • Refactor logging system for clarity
  • Update README with installation instructions
  • Remove deprecated API calls

Сообщения с дополнительным описанием

Fix rendering issue in graphics pipeline

The rendering pipeline had a bug causing frame drops on low-end GPUs. This fix optimizes shader execution and resolves the issue.

Add unit tests for input validation

Unit tests cover edge cases for user input to ensure stability and prevent crashes during unexpected inputs.

Типичные ошибки

  • Использование тегов или скобок:

    • Некорректно: [Fix] Resolve bug in module
    • Корректно: Fix bug in module

  • Начало не с глагола:

    • Некорректно: Bugfix for network error
    • Корректно: Fix network error

  • Неправильное использование глаголов:

    • Некорректно: Implementing new feature
    • Корректно: Implement new feature

  • Неполные предложения:

    • Некорректно: Fixed bug
    • Корректно: Fix UI layout bug

  • Неверное расположение существительного:

    • Некорректно: Add support new layout
    • Корректно: Add new layout support