Правила оформления issues - wolf1996/MSM GitHub Wiki
Если вы решили добавить issue
Если вы решили добавить issue, прошу следовать ряду правил. Это поможет нам коммуницировать с бОльшим кпд.
tag
В issue есть tag. Желателно ими пользоваться.
заголовок
В заголовке опишите суть проблемы, в одном\двух словах.
текст issue
В тексте issue будте кратки и информативны.
issue ошибки
опишите метод, в котором возникла ошибка, параметры (если есть). опишите текст ошибки \ код возврата. Если поведение отличается от ожидаемого, опишите ожидаемое поведение и поведение полученное в результате.
issue улучшения
Опишите метод поведение которого надо изменить. Опишите новое поведение, параметры и как их обрабатывать, и на какие части системы это повлеяет. Если изменения не связаны с новыми методами, правила те же. (что изменить, на что повлеяет). Опционально - указать зачем нам всё это.
issue уточнение
Укажите метод, по которому есть вопрос. Опишите вопрос подробно. Если вопрос связан с поведением метода, опишите, как именно получить это поведение, метод, параметры, предшествующие действия (если важно)