Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jest Unit Tests MASTER CASE #100

Open
16 tasks
GeorgeCiesinski opened this issue Mar 3, 2023 · 0 comments
Open
16 tasks

Jest Unit Tests MASTER CASE #100

GeorgeCiesinski opened this issue Mar 3, 2023 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@GeorgeCiesinski
Copy link
Owner

GeorgeCiesinski commented Mar 3, 2023

Note: This issue is still being built. Currently, existing files need to be checked for testable functions. Some files need to be refactored to improve unit testing. I will update this message once the MASTER CASE and child cases are complete.

Describe the new feature

The project needs functional unit tests for core features in order to prevent future contributions from breaking anything. In addition to this, a testing standard would be helpful to guide future collaborators to create their own tests for their new features.

Planning

Please create a case for any file you create unit tests for and mention this master case.

Ready for Unit Test

These files are probably ready for unit tests and may require minor refactoring.

  • commands
  • language
  • setupCommands
  • util

Prepare for Unit Test

These files contain large async functions which are difficult to test, and may require major refactoring before tests can be created.

  • catch
  • championship
  • delay
  • explore
  • help
  • index
  • leaderboard
  • mod
  • reveal
  • score
  • settings
  • timeout

Before Creating Unit Tests

The above two lists are just for guidance and to gather all of the existing modules in the program. Each of these should be gone through to determine the most vital functions which must be tested before tests are created.

Goals

The main goal of this master case is to decouple the code and make it more modular. This way if a change needs to be made we can avoid having to refactor an old module that we hardly remember, and a more specific, smaller module, can be altered instead. In short this should reduce technical debt down the line.

@GeorgeCiesinski GeorgeCiesinski added the enhancement New feature or request label Mar 3, 2023
@GeorgeCiesinski GeorgeCiesinski self-assigned this Mar 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant