Руководство разработчика (Оригинал здесь)

Для координации работы многих людей нам нужно описать руководство по нашей совместной работе.

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

Наш рабочий процесс делится на несколько частей:

• Создание тикета (с приаттаченным патчем);
• просмотр патча, обсуждение, пересмотр;
• применение патча

Руководство по созданию тикетов

Для облегчения процесса создания тикетов здесь приводятся некоторые рекомендации:

• Если вы хотите быть ответственным за тикет, то просто установите себя владельцем(owner) тикета и поменяйте статус тикета на 'accepted' (принят). Теперь Вы должны наблюдать за тикетом - есть патч или нет патча. В обоих случаях вы должны создать ветку (branch) для последующей работы в ней.
• Патчи с багфиксами разрешено применять к последней стабильной ветке. Эти ветки называются: mc-X.Y (например: mc-4.6). Патчи с новыми возможностями и реструктуризацией(рефакторингом) недопустимы в стабильных ветках - эти патчи нужно применять к основной ветке 'master'. Просьба также выбрать правильное направление (milestone) для данного тикета: для багфиксинга выберите последнее направление от стабильной ветки (напр. 4.6.2). Для остальных патчей или пожеланий выберите направление по умолчанию (в наст. время это 4.7)
• Создайте на основе необходимой ветки другую ветку (например, для багфиксинга создайте ветку от ветки mc-4.6). Все создаваемые ветки должны быть созданы на основе самого последнего коммита из родительской ветки. Новые ветки должны следовать правилу наименования: XYZ-<здесь_некоторое_описание>; где XYZ - это номер тикета; описание должно быть осмысленным и коротким, по возможности. Патчи из тикета не применяются непосредственно к родительской ветке, чтобы мы могли обсудить и пересмотреть при необходимости эти патчи.
• После создания ветки вы должны добавить к ключевым словам тикета (keywords) слово review для того, чтобы другие разработчики смогли ​увидеть ваш тикет как готовый к обзору и обсуждению. Вы можете не добавлять ключевого слова review; в этом случае ветка считается нестабильной и подлежит дальнейшей разработке.

Руководство по обзору тикетов

Так же, как существует руководство по созданию тикетов, так же существует и руководство по обзору тикетов.

• Список тикетов, которые необходимо просмотреть, находится по адресу: ​http://www.midnight-commander.org/report/9 ;
• Вы можете просмотреть и протестировать патч, просто переключившись на ветку для этого тикета;
• Если посмотреть на патч, то необходимо проверить:
  • является ли патч вкладывающимся в общую концепцию проекта или патч является "хаком"?
  • аккуратно ли выглядит код?
  • код делает то, что должен делать (что было задекларировано в комментарии к патчу)?
  • добавляет ли код новые баги (ошибки)?
• Если патч вам нравится (вы не нашли багов и вы согласны с идеей в патче), то вы должны добавить к ключевым словам тикета слово: vote-<login>; где логин - это ваш логин в trac. Если же патч не совсем безгрешный, то вы должны убрать ключевое слово review и потом можете выбрать дальнейшие ключевые слова:
  • Если необходимо просто "почистить" патч (убрать лишние пробелы, повставлять отступы и т.д.), то добавьте ключевое слово cleanup;
  • Если в в патче присутствуют ошибки (или патч является "хаком"), то необходимо добавить ключевое слово rework;
  • Если в патче присутствуют кардинальные изменения, сделающие master несовместимым со стабильной веткой, то такие тикеты должны быть заморожены до момента выпуска релиза на основе ветки master (и перед созданием новой стабильной ветки). Такие тикеты должны быть помечены ключевым стовом frozen.
• В настоящее время необходимы голоса двух разработчиков, чтобы патч был применён к родительской ветке (либо к стабильной ветке; либо к "master"). Если кто-либо вторым добавляет свой голос, то ему необходимо также добавить ключевое слово approved (утверждено) к списку существующих ключевых слов. Ключевое слово review должно быть убрано;
• Голосование всегда производится за последний патч в ветке;
• В ходе обсуждения в тикете либо в ходе просмотра патчей разработчики могут убирать свои голоса из списка ключевых слов при возникновении каких-либо проблем.

Руководство по применению патчей

• Владелец (ответственный) тикета теперь может внести исправления (находящиеся в ветке XYZ-<здесь_некоторое_описание>) в родительскую ветку. Перед внесением изменений в обязательном порядке нужно перебазировать (rebase) свою ветку относительно родительской. Если исправления были багфиксингом, то они должны примениться к стабильной ветке (mc-X.Y)
• В этом случае (багфиксинг на стабильную ветку) изменения считаются утерянными относительно ветки 'master'. Пожалуйста, НИКОГДА(!!!) не производите перебазирование (rebase) стабильного бранча относительно "master" чтобы объединить исправления!

Пример слияния с master:

  $ git checkout master              // переключение на ветвь "master"
  $ git pull                         // обновление текущей ветви
  $ git merge --log 123_branch_name  // слияние с "master" той ветви которую необходимо слить
  $ git push origin master           // обновление данных в удаленном репозитарии
  $ git push origin :123_branch_name // удаление ветви 123_branch_name на сервере 
  $ git branch -d 123_branch_name    // локальное удаление ветви 123_branch_name на клиентском хосте   

• Если слияние "merge" произошло с ошибкой (из-за конфликтов), то необходимо вручную исправить конфликты и продолжить слияние (merge)
• Теперь вы можете просто закрыть тикет с причиной закрытия "Fixed" (исправлено), необходимо также добавить ключевое слово commited-master если слияние происходило с ветвью "master". Состояние тикета поменяется на "testing"
• после этого перейдите на страницу ​http://midnight-commander.org/timeline и скопируйте от туда ссылку на результат слияния и добавьте ее в последнем комментарии примерно так

  Fixed: Changeset [http://midnight-commander.org/changeset/f8a487de01fda23370deb4efcdf6e4182c98e827 f8a487de01fda23370deb4efcdf6e4182c98e827]
  

  или так:

  Fixed: changeset:f8a487de01fda23370deb4efcdf6e4182c98e827
  

• после некоторого периода тестирования билет будет закрыт окончательно тикет-админом.

Если Вы не знакомы с git - пожалуйста, ознакомьтесь с нашим небольшим руководством по git