Unify naming conventions

Open
#5 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Refactor
Clarity
Needs clarification
Activity status
Stale
Tech stack
scala
Domain
testing

Research direction

Start with the README and inspect the uses of Timeout, timeout, CatsEffect, and IOSuite mentioned in the issue. Determine which naming convention should be applied consistently, then verify that the affected names and surrounding test-framework terminology are unified.

Written by the indexing model from the issue text.

Description

Just glancing at the readme:

  • Timeout vs timeout
  • CatsEffect vs IOSuite

Some of these should try to stay within the idiom of the surrounding test framework, so maybe we're already doing okay on the second point. We should try to unify on the first one, though.

Dominant language
Scala
Stars
194
Forks
42
Avg merge
5h 16m
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from typelevel/cats-effect-testing

All issues in typelevel/cats-effect-testing

Similar issues

More Scala issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.