BH TT Оформление бага
I. Общие правила русского языка:
1. Предложения начинаются с большой буквы, а заканчиваются точкой.
Заголовки начинаются с большой буквы, а точка после них не нужна.
2. После точки и запятой идёт пробел, а перед нет.
a. Как надо: “Вот пример текста, где всё верно.”
b. Почему? Чтобы запятая или точка не уехала одна на следующую строку
, вот так .
3. До открывающей скобки и после закрывающей есть пробелы,
а между скобками и текстом внутри - нет.
a. Как надо: (Вот пример текста, где всё верно.)
b. Почему? Чтобы скобка не уехала одна на следующую строку ( отдельно
) вот так .
II. Соблюдаем правила шаблона из статьи: Шаблон бага
1. Заголовки выделяем h5 или * - это будет жирный.
2. Нумеруем пункты шагов решетками:
Так, если понадобится вставить новый шаг, нумерация сама выравняется.
Единственный шаг нумеровать не надо.
# Пункт 1
## Подпункт пункта 1
## Подпункт пункта 1
# Пункт 2
3. Нет никакого текста до шагов. Никакого “краткого описания”.
4. Разделяем разделы пустыми строками.
III. Дополнительно:
5. Все глаголы ставим в неопределённой форме: “нажать”, “открыть”.
6. Названия кнопок и разделов пишем в кавычках и с большой буквы:
“Отмена” (или курсивом с помощью символов _ Отмена )
7. Даём скринам говорящие заголовки: “Сортировка.png”
IV. Теперь подробнее на примере (пример ниже, листайте):
1. В рамках курса мы (тренера) не знаем про какое приложение вы пишете. А баг нам проверить надо. Поэтому на первом же шаге нужно упомянуть название сайта или приложения. (В реальной жизни у вас будет весь баг-трекер только на один продукт, там это будет не нужно. Это правило только на время учёбы!)
2. Обязательно дать ссылку, максимально прямую, на тот раздел, где баг. Но при этом не полагаемся только на ссылку, она может сломаться. Так что пишем или путь к нужному месту по шагам или его название “открыть личный кабинет (ссылка)”. (Если у вас мобильное или десктопное приложение - дайте ссылку на его скачивание и используйте максимум скриншотов на шаги.)
3. Если баг только для авторизованных пользователей - обязательно указать данные для входа.
4. Все скриншоты:
(см. скрин Сортировка.png) -- или упоминаем в нужных местах с названием
!Сортировка.png! -- или прямо встраиваем в баг
#Сортировка.png -- или так будет сразу ссылка на баг
[^Сортировка.png] -- или в квадратных скобках
5. Названия скриншотов должны говорить сами за себя:
“правильная_сортировка.png”, а не “4w5lkhsr5lh.png”
6. Везде в шагах помним про статью про 6,9. Не пишите в баге «Ввести 6,9»!
7. И не забудьте прочитать и использовать все ссылки, которые мы дали в самой формулировке задания!
