Общие правила

Документирование

Исходные коды должны быть снабжены комментариями, достаточными для быстрого понимания назначения того или иного участка кода, и быстрого ознакомления с проектом в целом

Желательно писать качественные комментарии - не «что происходит в коде?», а комментарии, которые объясняют выбор решения (объясняют не то, что написано в коде, а то - чего в коде нет); они помогают понять происходящее и предпринять правильные шаги при развитии кода. Также по крупным задачам можно писать архитектурный комментарий – «как оно, вообще, устроено»: какие компоненты есть, поток взаимодействия, взгляд с высоты птичьего полёта

Документация и комментарии пишутся на английском языке

Java

Code style

Строгое соответствие https://google.github.io/styleguide/javaguide.html

Документирование

В качестве нотации для документирования кода используется JavaDoc

Для всех объектов (классы, интерфейсы и пр.) обязательна аннотация @author

Для интерфейсов - описание функциональное назначения, кроме интерфейсов репозиториев

Логгирование

Используется org.slf4j.Logger с аннотацией @Slf4j

JS

Code style

WIP: https://trello.com/c/MeRiNX3k/30-настроить-использование-линтера-eslint