OpenZeppelin / OpenZeppelin/openzeppelin-contracts
Properly document and maintain contract behavior test files
Nobody has claimed this yet.
- Dominant language
- Solidity
- Stars
- 27.2k
- Forks
- 12.4k
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 33
Description
It'd be nice if we could provide our behavior tests (e.g. Ownable) to users, so that they could in turn check that contracts inhering from those still preserve the base behavior (if applicable) and that it hasn't been accidentally broken (e.g. by overriding a modifier, etc.).
Related to #326.
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 with test/ownership/Ownable.behaviour.js and review the discussion in related issue #326. Determine how these behavior tests should be provided and maintained for users inheriting from the contracts. Done means users can run the relevant behavior tests to check that inherited contracts preserve the base behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, solidity
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100