-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
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:
- Feature-focused PRs: Each PR should address one main feature or fix
- Size limits: Suggest max 500-1000 lines changed per PR
- Logical grouping: Related changes stay together, unrelated changes split
Example Split for PR #89
Could have been split into:
- C++ compatibility fixes (register keyword removal)
- Thread safety implementation
- CI/CD workflow enhancements
- Test infrastructure additions
- 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
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation