OpenZeppelin / OpenZeppelin/compact-contracts
Improve when/how `@circuitInfo` is updated
Open
Nobody has claimed this yet.
1-medium
effort: 3-M
- Dominant language
- TypeScript
- Stars
- 55
- Forks
- 29
- Avg merge
- 5d 7h
- Merged PRs (30d)
- 25
Description
A very annoying and unproductive part of any code change is updating the @circuitInfo. Given that this is often changed, I propose we:
- Automate the process
- Update the numbers only once when preparing a release. Therefore, the release numbers are accurate when it's most meaningful and time isn't wasted updating/verifying/confirming/thinking about numbers that need to be updated/verified/confirmed/thought about again with any code change during development, review, and/or subsequent PR that touches the same code
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
The issue does not name files, tests, or entry points; start by locating uses of @circuitInfo and the repository's release process. Done means automating the updates and changing them only once when preparing a release, with release numbers accurate at that point.
Written by the indexing model from the issue text.
Assessment
- Domain
- release, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100