Как правильно описывать задачи в гиталаб

Что должна содержать задача

1. Цель: зачем мы это делаем, чем это должно помочь
2. Описание: как вы видете себе работу функции. Мы просим именно подробное пользовательское описание, как она должна работать, чтобы вам было удобно
3. Технические детали: расположения вызываемых файлов, навания функций. Их необязательно указывать сразу, но если есть понимание, то это очень поможет

Если есть понимание о реализации, можно его дополнить, мы обязательно учтем, и обсудим с вами

Пример хорошего описания

Цель: Автоматизировать проверку наличия, актуальности и обновление ассетов, необходимых для производства локации, в зависимости от типа задачи.

1. Общее описание
При нажатии исполнителем кнопки обновления, вызывается функция выполнения трех последовательных действий:

  1.Проверяет наличие необходимых ассетов в проекте (в зависимости от типа задачи).
  2. Если ассеты есть — проверяет, являются ли они последней версией.
  3. При необходимости — обновляет существующие или добавляет отсутствующие ассеты в проект.