<rmcreative>

RSS

Все заметки с тегом «issue»

  1. Как описать проблему

    19 августа

    Уже который год мне среди issue и тикетов встречаются такие, из прочтения которых вообще не ясно, в чём, собственно, проблема. Чтобы вас поняли нужно соблюсти следующие пункты:

    1. Что вы делаете? Важно описать точный набор шагов, следуя которым можно воспроизвести проблему. Стоит помнить, что вашего проекта у разбирающего issue нет.
    2. Что получаете?
    3. Чего ожидаете?
    4. Почему это проблема? Важный пункт. Описываем, почему мы ожидаем того что ожидаем и на что это влияет. Здесь важно показать не только что, допустим, из класса BaseService вернётся true вместо false, но и что это значит с точки зрения конечного пользователя.
    5. Не предлагать решение. Для этого есть pull request или комментарии.
    6. Не пытаться описать более одной проблемы за раз.
    Комментировать