Add guidance for large-scale refactoring/renaming #21
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Captured learning from PR #1238 in policyengine-uk where maintainer emphasized that variable/function renaming has "high potential to break things" and requires careful validation. Added section covering: - Test coverage requirements for renaming operations - Common breakage points (string references, dynamic lookups, etc.) - Validation strategies (tests, notebooks, grep for references) - Approval requirements even when tests pass This guidance helps future Claude Code sessions understand the risks and validation needs for large-scale refactoring operations. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Captured learning from working on policyengine-uk PR #1238 (renaming variables to lowercase).
The maintainer emphasized being "super careful" because variable/function renaming has "high potential to break things" even when most important variables already follow conventions.
Changes
Added new section to
policyengine-review-patterns-skillcovering:Why This Matters
Large-scale refactoring operations can break things through:
entity(variable_name, period)This guidance helps future Claude Code sessions understand the validation requirements for these high-risk operations.
🤖 Generated with Claude Code