Skip to content

Refactor: Break large PRs into smaller focused changes #90

@m-marinucci

Description

@m-marinucci

Context

As identified in PR #89 review by Sourcery-AI, large PRs that bundle multiple features make review difficult and rollback complex.

Problem

PR #89 contains:

  • C++ modernization changes
  • CI/CD workflow overhauls
  • Documentation updates
  • Test additions
  • Infrastructure improvements

This makes it:

  • Harder to review thoroughly
  • Difficult to identify regression sources
  • Complex to rollback specific changes

Proposed Solution

Establish guidelines for PR size and scope:

  1. Feature-focused PRs: Each PR should address one main feature or fix
  2. Size limits: Suggest max 500-1000 lines changed per PR
  3. Logical grouping: Related changes stay together, unrelated changes split

Example Split for PR #89

Could have been split into:

  1. C++ compatibility fixes (register keyword removal)
  2. Thread safety implementation
  3. CI/CD workflow enhancements
  4. Test infrastructure additions
  5. Documentation updates

Benefits

  • Easier review process
  • Faster merge cycles
  • Clearer git history
  • Simpler rollback if needed
  • Better issue tracking

Action Items

  • Create PR guidelines in CONTRIBUTING.md
  • Document recommended PR sizes
  • Add PR template with scope checklist
  • Consider using feature branches for large changes

Related: PR #89

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions