OpenZeppelin / OpenZeppelin/openzeppelin-upgrades
Code for the rename catch is confusing.
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 658
- Forks
- 286
- PR merge metrics
- No merged PRs in 30d
Description
This code is not really clear
const nameChange =
!this.unsafeAllowRenames &&
original.label !== updated.renamedFrom &&
(updated.label !== original.label ||
(updated.renamedFrom !== undefined && updated.renamedFrom !== original.renamedFrom));
(updated.renamedFrom !== undefined && updated.renamedFrom !== original.renamedFrom) is "if we are renaming, and we are not renaming what original renames from".
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read packages/core/src/storage/compare.ts around lines 101-105, starting with the linked rename-detection expression and its surrounding context. Clarify the implementation so the conditions for a rename and a changed source name are easier to understand, while preserving the existing behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- blockchain, devtools
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100