Вклад кода

Этот проект принимает все вклады через запросы на вытягивание. Код не должен быть отправлен непосредственно в master.

Следующие рекомендации применяются ко всем участникам.

Внесение изменений

• Форкните репозиторий apache/griffin.
• Внесите изменения и отправьте их в тематическую ветку вашего форка.
  • См. наши рекомендации по оформлению коммитов ниже в этом документе.
• Отправьте запрос на вытягивание в репозиторий apache/griffin.

Общие рекомендации

Наши рекомендации по оформлению коммитов соответствуют рекомендациям [OpenStack][OpenStack]:

• Только одно логическое изменение на коммит.
• Не смешивайте изменения пробелов с функциональными изменениями кода.
• Не смешивайте несвязанные функциональные изменения.
• При написании сообщения коммита:
  • Опишите, почему вносятся изменения.
  • Не предполагайте, что рецензент понимает, в чём была исходная проблема.
  • Не полагайтесь на то, что код является самоочевидным/самодокументированным.
  • Охарактеризуйте любые ограничения текущего кода.

Рекомендации по оформлению сообщений коммитов

Наши рекомендации по оформлению сообщений коммитов также соответствуют рекомендациям OpenStack:

• Предоставьте краткое описание изменения в первой строке.
• После первой строки вставьте одну пустую строку.
• Предоставьте подробное описание изменения в следующих строках, разбивая абзацы там, где это необходимо.
• Первая строка должна содержать не более 50 символов и не должна заканчиваться точкой.
• Следующие строки должны переноситься после 72 символов.

Обратите внимание: в сообщениях Git коммиты первая строка имеет особое значение. Она используется в качестве темы электронного письма, в сообщениях аннотирования git, в аннотациях просмотра gitk, в сообщениях о слиянии коммитов и во многих других местах, где пространство ограничено. Пожалуйста, постарайтесь написать хорошую первую строку!

Пример хорошего оформления:

Поддержка двоичного протокола для mcrouter

В дополнение к существующему текстовому протоколу ASCII поддерживается двоичный протокол. Двоичный протокол имеет лучшую производительность, поскольку анализ двоичной строки эффективнее анализа текстовой строки.

Правила оформления кода на Java

Предполагая, что вы используете Eclipse:

Перейдите в Eclipse > Preferences, затем:

Java > Редактор > Сохранить действия:

• Снимите флажок «Форматировать исходный код».
• Установите флажок «Организовать импорт».
• Установите флажок «Дополнительные действия» и добавьте следующие действия:
  • «Удалить неиспользуемый импорт».
  • «Убрать завершающие пробелы во всех строках».

Общие > Редакторы > Текстовые редакторы:

• Установите флажок «Показывать поле печати» и установите значение 80.

Также применяется дополнительный набор правил из Руководства по стилю Google Java:

• 4.1.1 Скобки используются там, где они необязательны.
• 4.1.2 Блоки без пустого пространства: стиль K & R.
• 4.4 Лимит столбцов: 80.
• 4.8.2.2 Объявлено при необходимости, инициализировано как можно скорее.
• 6.1 @Override: всегда используется.
• 6.2 Пойманные исключения: не игнорируются.
• 6.3 Статические члены: квалифицированы с использованием класса.
• 6.4 Финализаторы: не используются.

[OpenStack] — https://wiki.openstack.org/wiki/GitCommitMessages