Порядок возврата кода (Check-in)
2017 год
-
Ошибки
Необходимо убедиться в том, что все проекты решения собираются без ошибок (error). Не допускается возврат изменений, если есть хоть одна ошибка при сборке. -
Предупреждения
Необходимо убедиться в том, что при сборке всех проектов решения количество предупреждений (warning) не увеличилось.
Возврат изменений с увеличением количества предупреждений возможен лишь после согласования этого факта с руководителем проекта. -
Анализ кода
Необходимо убедиться в том, что при сборке всех проектов решения с успехом (без ошибок и предупреждений) проходит процедура анализа кода. -
Анализ текста
Необходимо убедиться в том, что в возвращаемых файлах успешно проходит проверка текста:
если некоторые слова подчёркнуты, то для каждого из них требуется выполнить одно из следующих действий- исправить слово, написанное с ошибкой,
- попросить ответственного сотрудника добавить слово в словарь или список ислючений,
- получить разрешение на возврат файла без исправления подчёркнутых строк.
-
Тестирование
- Необходимо убедиться, что для разработанного, в рамках задачи, функционала, есть соответствующие тесты.
- Необходимо запустить все тесты проектов и убедиться, что никакой, ранее созданный, функционал не нарушен.
-
Документирование
-
Необходимо убедиться в том, что все добавленные элементы кода должным образом документированы.
При документировании необходимо соблюдать стилистику. Нужно отыскивать сходный по смыслу функционал и оформлять документацию по аналогии. Если такой функционал не найден - поиск на MSDN точно поможет, копирование текста оттуда - правильный подход. При этом без фанатизма - текст, переведенный машинным способом следует подкорректировать. - В случае правок ранее существовавшего кода, необходимо убедиться, что прежний текст документации все еще является актуальным и отражает смысл функционала с учетом внесенных изменений.
-
Необходимо убедиться в том, что все добавленные элементы кода должным образом документированы.
-
Задача
Необходимо указать задачу, по которой была проведена правка. Возврат изменений без ссылки на задачу недопустим. -
Комментарии возврата
Необходимо указать комментарий возврата - следует скопировать наименование задачи.
Примечание: предложение должно заканчиваться точкой.