Skip to content

Шаблон знахідки код-рев'ю

Використовуйте цей шаблон для документування кожної знайденої проблеми під час код-рев'ю.


Проблема: [НАЗВА]

Серйозність

  • Критична (блокує деплой)
  • Висока (потрібно виправити перед мерджем)
  • Середня (потрібно виправити незабаром)
  • Низька (бажано виправити)

Категорія

  • Безпека
  • Продуктивність
  • Якість коду
  • Підтримуваність
  • Тестування
  • Патерн проєктування
  • Документація

Розташування

Файл: src/components/UserCard.tsx

Рядки: 45-52

Функція/Метод: renderUserDetails()

Опис проблеми

Що: Опишіть суть проблеми.

Чому це важливо: Поясніть вплив та чому це потрібно виправити.

Поточна поведінка: Покажіть проблемний код або поведінку.

Очікувана поведінка: Опишіть, що повинно відбуватися замість цього.

Приклад коду

Поточний (проблемний)

typescript
// Shows the N+1 query problem
const users = fetchUsers();
users.forEach(user => {
  const posts = fetchUserPosts(user.id); // Query per user!
  renderUserPosts(posts);
});

Запропоноване виправлення

typescript
// Optimized with JOIN query
const usersWithPosts = fetchUsersWithPosts();
usersWithPosts.forEach(({ user, posts }) => {
  renderUserPosts(posts);
});

Аналіз впливу

АспектВпливСерйозність
Продуктивність100+ запитів для 20 користувачівВисока
Досвід користувачаПовільне завантаження сторінкиВисока
МасштабованістьЛамається при масштабуванніКритична
ПідтримуваністьСкладно дебажитиСередня

Пов'язані проблеми

  • Аналогічна проблема в AdminUserList.tsx рядок 120
  • Пов'язаний PR: #456
  • Пов'язана issue: #789

Додаткові ресурси

Нотатки рецензента

  • Це поширений патерн у цій кодовій базі
  • Варто додати це до гайду зі стилю коду
  • Можливо, варто створити допоміжну функцію

Відповідь автора (для зворотного зв'язку)

Заповнюється автором коду:

  • Виправлення реалізовано в коміті: abc123
  • Статус виправлення: Завершено / В процесі / Потребує обговорення
  • Питання або зауваження: (опишіть)

Статистика знахідок (для рецензента)

При рев'ю кількох знахідок, відстежуйте:

  • Всього знайдено проблем: X
  • Критичних: X
  • Високих: X
  • Середніх: X
  • Низьких: X

Рекомендація: ✅ Затвердити / ⚠️ Запросити зміни / 🔄 Потребує обговорення

Загальна якість коду: 1-5 зірок