Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 30, 2025

Code reviews lacked systematic guidance, allowing architectural violations like #75 (config module in wrong DDD layer) to merge undetected. Reviewers needed a consolidated checklist of quality standards and common red flags.

Changes

New PR Review Guide (docs/contributing/pr-review-guide.md)

Quality Standards Checklist - Systematic verification of:

  • Branching/commits (naming, conventional format)
  • Code quality (DDD layer placement, error handling, module organization)
  • Testing (coverage, conventions, isolation)
  • Documentation (ADRs, rustdoc)
  • Templates (Tera syntax, Ansible registration)

Quick Red Flags - Fast-scanning checklist for common violations:

Architecture Violations:
- ❌ File I/O in domain/application layers
- ❌ Business logic in infrastructure/presentation
- ❌ Presentation directly calling infrastructure

Error Handling Issues:
- ❌ Generic string errors instead of typed enums
- ❌ Errors without context or actionable guidance

Feedback Guidance - When to request changes vs. comment vs. approve, with examples showing how to reference documentation:

> This error handling doesn't follow [error-handling.md](./error-handling.md).
> See `src/domain/config/error.rs` for the typed error enum pattern.

Living Document - Framework for continuous improvement as patterns emerge

Issue Template Updates

Added contributor note to SPECIFICATION-TEMPLATE.md and GITHUB-ISSUE-TEMPLATE.md:

These criteria define what the PR reviewer will check. Use this as your pre-review checklist before submitting.

Documentation Integration

  • Added "Acceptance Criteria as PR Review Checklist" section to roadmap-issues.md explaining dual purpose (for authors and contributors)
  • Linked from docs/contributing/README.md for discoverability

Cross-References

Guide links to: DDD layer placement, error handling, module organization, branching, commit process, testing conventions, templates, known issues, and development principles.

Original prompt

This section details on the original issue you should resolve

<issue_title>Add PR Review Guide for Contributors</issue_title>
<issue_description># Add PR Review Guide for Contributors

📋 Issue Information

🎯 Problem Statement

Code reviews currently lack a systematic guide for reviewers. This has allowed issues like architectural violations (#75 - config module in wrong layer) to be merged without detection.

Reviewers need:

  • A quick reference guide for important review aspects
  • Clear red flags to watch for
  • Consistent review criteria across all PRs

Without a standardized guide, we risk:

  • Merging code that violates architectural principles
  • Inconsistent review quality
  • Missing important quality aspects
  • Technical debt accumulation

💡 Proposed Solution

Create a concise PR review guide at docs/contributing/pr-review-guide.md that consolidates project quality standards for reviewers, including a comprehensive checklist, quick red flags section, and guidance on providing constructive feedback.

📝 Implementation Plan

See detailed specification: docs/issues/add-pr-review-guide.md

✅ Acceptance Criteria

Note for Contributors: These criteria define what the PR reviewer will check. Use this as your pre-review checklist before submitting the PR to minimize back-and-forth iterations.

  • Document created at docs/contributing/pr-review-guide.md
  • Comprehensive quality standards checklist included
  • Checklist covers: branching, commits, code quality, testing, documentation
  • Quick red flags section for common violations
  • Example feedback showing how to reference docs
  • Guidance on when to request changes vs. comment vs. approve
  • Issue templates updated with contributor note about acceptance criteria
  • docs/issues/SPECIFICATION-TEMPLATE.md updated with pre-review checklist note
  • docs/issues/GITHUB-ISSUE-TEMPLATE.md updated with pre-review checklist note
  • docs/contributing/roadmap-issues.md updated with "Acceptance Criteria as PR Review Checklist" section
  • Linked from docs/contributing/README.md
  • All linters pass (markdownlint, cspell)
  • Document follows project markdown conventions
  • Clearly states it's a living document that will evolve

🏷️ Labels

documentation, enhancement, code-review, contributing-guide</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI changed the title [WIP] Add PR review guide for contributors Add PR Review Guide for systematic code reviews Oct 30, 2025
Copilot AI requested a review from josecelano October 30, 2025 17:47
Copilot finished work on behalf of josecelano October 30, 2025 17:47
Copy link
Member

@josecelano josecelano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK 533a700

@josecelano josecelano marked this pull request as ready for review October 30, 2025 17:52
@josecelano josecelano merged commit b8e1024 into main Oct 30, 2025
51 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add PR Review Guide for Contributors

2 participants