Правила заполнения тикетов для лейбла to do - NurOrNuLL/ESDP-AP-5-6-TEAM-2 GitHub Wiki

Правила заполнения тикетов для to do

Конечный результат:

  • Конечный результат - что нужно сделать?. Здесь описывается конечный результат, что должно получиться в результате решение задачи. При необходимости, здесь также описывается план достижения результата, как его достичь, если в нём есть какие-то важные шаги, которые нужно учесть или он неочевиден.
  • Пример Реализовать просмотр детальной страницы пользователя

План решения:

  • Описания решения задачи с упоминанием всех действии и файлов в которых будут касаться или коснулись изменения при решении новой задачи
  • Пример Написать urls для детальной страницы пользователя
  • Пример Написать views для детальной страницы пользователя
  • Пример Добавить шаблон для детальной страницы пользователя

Мотивация:

  • Мотивация - зачем это нужно сделать?. Здесь описывается мотивация для разработчика решать эту задачу. Это нужно пользователям? Это нужно заказчику (есть в ТЗ)? Это предложил аналитик (зачем)? Это нужно для решения других задач? Если вы не можете описать этот пункт, значит ваше представление результата может сильно отличаться от того, что нужно пользователям или заказчику, и придётся задачу переделывать, или, возможно, она вовсе не нужна.
  • Пример Для возможности просмотра детальной информации о пользователе

Критерии приемки:

  • Критерии приёмки - как проверить, что задача решена?. Здесь описывается способ, которым можно проверить, что задача соответствует требованиям к ней. Например, это может быть пользовательский сценарий - пошаговое описание действий пользователя в интерфейсе и результата, который он получит после выполнения этих действий. Одной задаче может соответствовать несколько сценариев - например, для разных типов пользователей (права доступа), для выполнения действий с ошибками или без (заполнение форм) и т.д.
  • Пример Попробовать зайти в проект выбрать пользователя для детального просмотра, нажать на кнопку детального просмотра, увидеть инф. о пользователе и убедится что все работает

Пример title:

Создание страницы авторизации

Пример body:


## Конечный результат:
* Реализовать страницу авторизации пользователя

## План решения:
* Написать urls для авторизации
* Написать views для авторизации
* Добавить шаблон для авторизации

## Мотивация:
* Нужна для того, чтобы пользователь смог авторизоваться. Если он не авторизуется, тогда не сможет пользоваться программой.

## Критерии приемки:
* Перейти на сайт
* Откроется страница авторизации
* Авторизоваться и убедиться, что все работает

## Планируемое время выполнения:
* 1 час