m777553 / angular-review-checklist Goto Github PK

Git points

1. Название ПР корректно, кратко и достаточно
2. Есть ли комментарий к изменениям, не относящимся к основной задаче реквеста напрямую?
3. Правильно ли выбрана ветка для вливания реквеста
4. Соблюдается ли правило – одна ветвь – один коммит?

General points

1. Работает ли код

   a. Код выполняет ту и ТОЛЬКО ту задачу, которая задана

   b. Код не эффектит остальные части приложения незапланированным образом

   c. Легко понять, что делает код (KISS, YANGNI) благодаря его структуре и названиям

2. Использованы имеющиеся на проекте библиотеки, а не изобретено кастомное решение

3. Нет повтора кода (DRY)

4. Названия переменных, файлов и тд с использованием naming conventions проекта

5. Соблюдается code conventions принятые на проекте

6. Есть локализация (опционно)

7. Код очищен от неиспользуемых переменных и комментариев (комментарий НЕ должен описывать КАК это работает, А объяснять ЗАЧЕМ)

8. Нет hardcode значений

9. Константы и модели данных вынесены в отдельные файлы

Angular points

1. Типизация выполнена

2. Использованы стандарты и гайдлайны фреймворка

3. Использованы best practice фреймворка

   a. Желательно использовать модульную архитектуру

   b. Использовать trackBy с *ngFor

   c. Использовать ChangeDetectionStrategy.OnPush при возможности

   d. Отписываться от потоков или (что лучше) использовать пайп async

   e. Использовать CDK(Component Development Kit) Virtual Scroll для больших списков

   f. Стараться оставлять подписку пустой и не делать подписку в подписке! .subscribe(()=>obs$.subscribe())

   g. Использовать интерфейсы

   h. Избегать мутирования объектов

   i. Стартовые данные описывать не в конструкторе, а в хуке ngOnInit

   j. При необходимости использовать Route Guards для навигации

   k. Использовать *ngIf для скрытия эл-тов, а не CSS

   l. Предпочитать реактивные формы шаблонным

Style points

1. Использован БЭМ
2. Селекторы логически сгруппированы
3. Использованы заданные проектом константы
4. Избегать использования !important, absolute positioning
5. Избегать задания фиксированной высоты
6. Избегать использования тэгов в качестве селекторов вместо классов
7. Переписывание стилей библиотек в специальных override файлах – не использовать ::ng-deep