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

Refactor task scripts following TDD principles #407

Open
4 tasks
sophie22 opened this issue Jan 18, 2024 · 0 comments
Open
4 tasks

Refactor task scripts following TDD principles #407

sophie22 opened this issue Jan 18, 2024 · 0 comments

Comments

@sophie22
Copy link
Collaborator

sophie22 commented Jan 18, 2024

With the exception of snr_map and largely the ACR tasks scripts, most tasks do not follow software development best practices. This makes the code unnecessarily convoluted, difficult to debug/test and expand with new features.

Test-driven development and refactoring should be implemented. Updating the hazenlib tasks following object-oriented principles will result in a code that is easier to understand, use, test and productionise.

  • review existing code and identify common functions that can be made into the shared utilities
  • refactor each task script with OOP and TDD principles, which will improve the test coverage as well (currently only 72%)
  • simplify scripts and functions where possible
  • make variable names more verbose, descriptive and standardised across scripts
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: To do
Development

No branches or pull requests

1 participant