Как проводить ревью кода с проверяемыми замечаниями.
Ревью должно связывать замечания с конкретным поведением или риском. Не считайте стилевые предпочтения дефектами без соответствующего соглашения проекта.
Адаптируйте процесс под свою задачу.
Проверяйте код по ожидаемому поведению и соглашениям, связывая замечания с конкретными строками или случаями. Различайте дефекты, значимые риски и необязательные стилевые предложения; по возможности приводите воспроизводимый пример.
- Что вы предоставляете
- Изменения кода и соглашения проекта.
- Что вы получите
- Потенциальные дефекты и проблемы сопровождаемости со ссылками.
Посмотрите входные данные и результат.
Иллюстративные входные и выходные данные · учебный пример, а не реальный запуск WebAct
Полей ввода: Пример
Python code review: def average(total, count): return total / count. No zero-count contract supplied.
Готовый пример
Finding: count=0 raises ZeroDivisionError. Reproduction: average(10, 0). Contract question: should an empty set return a designated value or raise a deliberate domain error? Proposed action: define that behavior and add a zero-count test before changing the implementation. Ordinary nonzero division is not itself identified as a defect.
Добавьте эти данные в промпт и скопируйте его в WebAct, чтобы попробовать задачу. Ваш результат может отличаться от примера.
Решения и устранение проблем.
Нужно ли отмечать стилевые предпочтения как баги?
Классифицируйте их по соглашениям проекта. Предпочтение отличается от поведения, нарушающего требование.
Почему ревью отмечает проблему, которую вызывающий код уже предотвращает?
Изучите контракт функции и места вызова. Укажите допущение вместо оценки фрагмента как лишённого контекста.
Попробуйте на собственном источнике.
Замените пример своим материалом в промпте. Сохраните нужные требования и скопируйте задачу в WebAct.
Настроить и скопировать задачу ↑