Кодстайл вайт дрим 2024

[ThereDrD0]

Напишу все тут, чтобы это было прописано в одном месте

Гит

1. В мастер не срем. Создаем пулреквесты
2. Если вы закончили работу над пулреквестом, вешайте плашку Ready to merge, чтобы показать, что вы закончили.

3. Если ваша фича требует изменения на картах, укажите в самом ПРе что именно. За карты отвечает хедмаппер, дождитесь, пока он сам сделает изменения на картах
4. Называя ваши коммиты описывайте, что вы там делаете. Добавляете что-то, фиксите, убираете. Язык не важн
5. Пулреквесты называйте по-русски, чтобы в поиске было легче найти ваш пр
6. Если переносите откуда-то фичи - используйте git cherry-pick, а не переносите все руками.
7. Создавайте чейнжлог, пишите в нем все подробно. Игроки любят следить за изменениями на сервере

Как выглядит чейжлог. Чейнжлог пишется после английского Changelog и значка 🆑. Если не писать имя после значка, в изменения пойдет ваш ник на гите

Код

1. Все ваши фичи должны находиться в папках White. Это облегчит понимание, что является нашим кодом, а что нет.
2. Если ваш код требует изменения в системе пендосов, то помечайте их плашка // WD edit start и // WD edit end в начале и конце ваших изменений.
3. Для одиночной строки хватит просто // WD
4. Старайтесь придерживаться кодстайла пендосов. Разделяйте методы по смыслу, выделяйте повторяющийся код в отдельные методы, старайтесь использовать прототипы. Создавайте новые прототипы. Прототипы это прекрасный способ упростить работу с логикой.
5. Соблюдайте стиль названий, давайте полные названия. Старайтесь избегать сокращений, например Sec, лучше полностью прописать Security.
6. Если вы что-то меняете айдишник в прототипе, заменяете один прототип на другой, схожий по функционалу - используйте миграции в файле migration.yml, чтобы код автоматически заменял все старые прототипы на новые. Это поможет избежать множество ошибок, особенно если прототип сделали пендосы и они будут использовать старый айдишник.

Работа друг с другом

1. Если какой-то из кодеров занимается какой-то определенной фичей или областью кода, и вы хотите что-то поменять там - посоветуйтесь с ним или попросите об этом его. Намного лучше, когда это сделает человек, который уже разобрался, что к чему.
2. Старайтесь избегать обсуждение в личках, все вопросы или споры по коду лучше вести в кодерканале, чтобы другие люди могли высказать свое мнение. Это полезно

Карты

1. Вы карты не трогаете. Карты делают мапперы, сохраняют в свою базу карт. Затем хедмаппер заливает сюда карты.
2. За изменениями карт обращайтесь к хедмапперу. Если ваша фича требует расстановки на картах предметов - зовите хедмаппера, просите обновить карты на вашей ветке

Спрайты

1. Если вам нужны спрайты для вашей фичи - перейдите на наш сервер.
2. Затем попросите плашку кодера и перейдите в канал спрайтеров.
   
3. Попросите хедспрайтеров создать для вашей фичи ТЗ
4. Ожидайте от спрайтеров архива со спрайтами

Переводы

1. Все изменения переводов, которые сделаны вами переносите в White папку
2. Если вы добавляете фичу - добавляйте для нее переводы через систему локализации с использованием ftl файлов.

[DVOniksWyvern]

Если есть вопросы по именно геймдизайну/направлению/нужде/любое другое - пишите мне в дискорд, ONIKS если что.
Я доступен 24 на 7, если не сплю и не на работе,