nusmodifications / nusmodifications/nusmods
Improve tests structure
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 689
- Forks
- 364
- Avg merge
- 7h 5m
- Merged PRs (30d)
- 14
Description
When https://github.com/facebook/jest/pull/5154 gets released, we should probably relook at our describe and test blocks. Some of them do not have a top level describe and phrasing is inconsistent across the various tests. This is a good chance to clean them up.
Proposed format:
- Top-level
describewith the component name that you are testing for. - For testing methods, use
MyComponent.myMethod.
Feel free to add on to this. The purpose is to make them consistent across the code base.
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 reviewing the repository's existing test files and the proposed Jest release mentioned in the issue. Identify tests without a top-level describe and inconsistent describe/test phrasing, then apply the proposed naming format consistently across the codebase.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- testing-qa
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100