Add guideline for redundant tests
Open
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 5.5k
- Forks
- 1.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 5
Description
Laws for type class inherited from a parent type class also includes laws for the parent type class. Thus when testing an instance it's redundant to test laws for both type classes.
The current code base is not consistent in regards to this redundancy. We need to come up with a principle and add to the guideline.
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 locating the existing testing guideline and reviewing the inconsistent law tests in the Cats codebase. Determine a principle for handling inherited type-class laws, then document it in the guideline; done means the rule is explicit and addresses the reported redundancy.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100