OpenZeppelin / OpenZeppelin/compact-contracts
Remove `TODO`s from code
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 55
- Forks
- 29
- Avg merge
- 5d 7h
- Merged PRs (30d)
- 25
Description
They're ugly and add clutter. To keep code clean, open issues for scattered TODOs in repo. If the TODO is a workaround for something, cite the issue that's tracking the thing to do and cut the TODO
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
Start by searching the repository for TODO markers and review each occurrence in context. Remove TODOs that are no longer needed; for workarounds, cite the issue tracking the work, and open issues for scattered TODOs that still need follow-up. Done means the actionable TODO clutter has been removed and remaining work is traceable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100