feat(docs): add issue_processing.md

ChaoticOnyx · Apr 9, 2020 · b5ffbc9 · b5ffbc9
1 parent 37a2f9b
commit b5ffbc9
Showing 1 changed file with 56 additions and 0 deletions.
diff --git a/docs/issues_processing.md b/docs/issues_processing.md
@@ -0,0 +1,56 @@
+# Процесс обработки Issues
+
+Все иссуи заводятся на гитхабе либо как баги, либо как предложения к улучшению. У каждой иссуи на гитхабе всегда должна быть плашка бага или улучшения.
+
+## Требуется проверка
+
+Первый этап любой иссуи - они все создаются с такой плашкой. На этом этапе любой человек с доступом к управлению плашками (разработчик, геймдизайнер, тестер и т.д.) должен сделать следующие вещи, после чего **снять плашку "нужна проверка"**:
+
+1. **Проверить адекватность.** Убедиться, что иссуя относится к билду, а также соответствует правилам сообщества и гитхаба. Если это не выполняется, то иссую следует сразу закрыть, написав причину в комментариях. Если баг не баг, то можно повесить плашку "так и хотели".
+1. **Баг или предложение.** Проверить правильно ли стоит плашка "баг" или "предложение". Баг - это исправление ошибок в существующих механиках, предложение - новые механики или расширение/перепил старых.
+1. **Проверить дубликаты.** Проверить что на гитхабе уже нет похожих иссуев. Если есть, то написать об этом в комментарии со ссылкой на предыдущую такую же багу (в формате `#1234`), добавить плашку "дубликат" и закрыть иссуй. Если в иссуе предоставлена дополнительная информация, которая может помочь разобраться с предыдущей иссуей, об этом стоит упоминуть в первоначальной иссуе.
+1. **Уточнить название/описание.** Если есть возможность написать более понятно то, что написал игрок - это стоит сделать. Если описание автора совсем плохое и нужно переписать его полностью, то можно оставить его в виде цитаты в конце описания.
+1. **Баг: достаточно ли информации?** Если иссуя - баг, то оценить насколько он реальный. Если есть основания полагать, что бага не существует, или сложно понять в чем конкретно заключается баг, то надо уточнить это у автора в комментариях и повесить "требуется информация", пока автор не ответит и ситуация не прояснится.
+1. **Предложение: касается геймдизайна?**  Если это предложение, то оценить, касается ли предложение игрового экспириенса игроков (все, чего касаются игроки. Педальных кнопок, например, не касаются). Если касается, то вешаем плашки "геймдизайн" и "требуется проработка".
+1. **Повесить плашки областей разработки.** Посмотреть какие плашки областей могут относится к иссуе и повесить их (ИИ, медицина, режимы и т.д.).
+1. **Оценить приоритет.** Если все очень плохо - наивысший приоритет. Если игроки сталкиваются с этим каждый день и баг мешает каким-то основным механикам - повышенный приоритет, если мелочь, типо цвет галстука поменять, то пониженный.
+1. **Оценить сложность.** Этот пункт касается только разработчиков - только они могут вешать плашки сложности. Зависит от времени, которое нужно потратить на решение проблемы. Если примерно сразу понятно где смотреть и что там одна строчка - это просто. Если нужно трогать БД или писать/перерыть много кода - сложно.
+
+## Требуется проработка
+
+Этот этап касается только улучшений. Здесь нужно ответить на все вопросы разработчиков, которые могут у них возникнуть, касательно того, как именно должно отразиться улучшение на игре с точки зрения обычных игроков.
+
+Здесь нужно предоставить ПОДРОБНЫЙ геймдизайн фичи, конкретику. Что поменять, насколько поменять, с каким конкретно шансом что-то должно происходить. Какие нужны спрайты, в каких случаях эти спрайты должны показываться. 
+
+Например, вы хотите добавить новый режим? Как часто этот режим должен появляться? Какие цели у этого режима? Какие роли? Какую экипировку получают эти новые роли, где они спавнятся? Какие условия завершения раунда? Какой урон должна наносить новая вундервафля, которую вы хотите добавить в этот режим? Должна ли она станить?
+
+В общем в результате, после проработки, разработчик должен прийти и просто реализовать вашу идею. Он не должен думать "а мне поставить шанс 10 или 30%", он не должен искать спрайты - он должен просто прийти и написать код, чтобы он в точности выполнял то, что написано в иссуе.
+
+### Основные моменты:
+
+1. **Кто?** Проработкой, в первую очередь, должен заниматься автор идеи. Если идея брошена автором, то проработать ее может кто угодно еще.
+1. **Что должно получиться в итоге?** В результате проработки ОПИСАНИЕ иссуи (то есть первый пост) должен содержать достаточную информацию о том, как должна выглядеть иссуя в результате с точки зрения игрока.
+1. **Я не могу изменять описание иссуи.** Если у вас нет прав менять описания иссуев, но вы хотите прорабатывать идеи - прорабатывайте их в комментариях. Людям, которые будут активно помогать с этой частью, будут выдавать права, чтобы прорабатывать иссуи прямо в описании.
+1. **Спрашивайте заранее.** Перед проработкой можно уточнить у геймдизайнеров подойдет ли идея в общем, чтобы не прописывать мелкие детали идеи, которая не будет реализована ни в каком виде. Однако, на данный момент идеи принимаются довольно либерально и если вы не предлагаете что-то излишне экзотическое, скорее всего это будет принято.
+1. **Как проработать еще лучше.** Чтобы лучше проработать идею - можно попросить кодеров позадавать наводящие вопросы. В конце концов именно им реализовывать и если они посчитают идею недостаточно проработанной - они могут вернуть обратно плашку с дополнительными вопросами и попросить проработать до конца.
+1. **Заканчиваем проработку.** Если вы считаете, что иссуя проработана и не вызовет вопросов у разработчиков касательно того что должно получится в итоге - снимайте плашку. Дальше она попадает либо геймдизайнера на подтверждение, либо сразу к разработчикам, если подтверждение не требуется.
+
+## Геймдизайн
+
+Плашка "геймдизайн" вешается только на те иссуи, которые затрагивают игровой экспириенс игроков.
+
+Геймдизайнеры должны проверять все иссуи с плашкой "геймдизайн" и высказываться за/против принятия улучшения в билд, если иссуя проработана и не вызывает вопросов к автору иссуи (нет плашек "требуется проработка", "нужна информация" и т.д.).
+
+Если все геймдизайнеры высказались, то иссуя считается одобреной, если большая часть геймдизайнеров высказались за.
+
+## Разработка
+
+Чтобы попасть в разработку у иссуи не должно быть плашек "требуется проверка", "требуется проработка", "нужна информация". Если иссуя - это предложение с плашкой "геймдизайн", то у нее должна быть плашка "одобрено".
+
+### Награда за разработку
+
+За иссуи, которые попадают на этап разработки, может быть выставлена награда путем голосования совета или донатеров. Подробнее про донаты и то, как донатеры могут голосовать за то, какие иссуи спонсировать - можно почитать в нашем дискорде.
+
+## Пулл Реквесты
+
+Все Пулл Реквесты так или иначе проходят такие же проверки. Проверяется адекватность, нужность, а если касается геймдиза - проходит этап одобрения и так далее. Чтобы не потратить время впустую и не стать обладателем отклоненного ПРа рекомендуется заливать ПРы только связанные с какими-то иссуями, которые попали на этап разработки.