Как правильно описывать задачи в GitLab
Что должна содержать задача
- Цель: зачем мы это делаем, чем это должно помочь
- Описание: как вы видете себе работу функции. Мы просим именно подробное пользовательское описание, как она должна работать, чтобы вам было удобно
- Технические детали: расположения используемых файлов, названия функций. Если у вас нет точного понимая, скажите, мы их уточним с вами в диалоге
Если есть точное понимание о реализации, можно его также указать, мы обязательно учтем, и обсудим с вами
Пример хорошего описания
Цель
Автоматизировать проверку наличия, актуальности и обновление ассетов, необходимых для производства локации, в зависимости от типа задачи.Общее описание
При нажатии исполнителем кнопки обновления, вызывается функция выполнения трех последовательных действий:1.Проверяет наличие необходимых ассетов в проекте (в зависимости от типа задачи).
2. Если ассеты есть — проверяет, являются ли они последней версией.
3. При необходимости — обновляет существующие или добавляет отсутствующие ассеты в проект.
Куда нести задачу
Ее можно отправить текстом в ТГ RnD чат вашего проекта или сразу завести задачу в GitLab, и тэгнуть @vzavalishin
(Он проставит на нее нужные тэги. Его ответственность, чтобы ваша задача не потерялась и была выполнена)
Важно отделить текущие проблемы от пожеланий по доработке:
Проблемы/ошибки в работе существующих инструментов нужно отправлять в нашу поддержку в ТГ боте: @yarko_helpdesk_bot
Вам ответит наш дружный коллектив RnD, и если проблема сложная и решается больше одного дня, мы перенесем ее в GitLab и отправим вам ссылку, чтобы вы могли за ней смотреть при необходимости
No comments to display
No comments to display