Skip to content

Conversation

@Freezor
Copy link

@Freezor Freezor commented May 16, 2024

Description

This pull request includes a series of refactoring changes and enhancements to improve code readability, maintainability, and test coverage for the JsonCanonicalizer class. The changes address several aspects, including method extraction, naming improvements, and the addition of comprehensive unit tests.

Motivation and Context

  • Refactoring for readability: The changes aim to simplify the code structure, making it easier to understand and maintain.
  • Enhanced test coverage: Additional tests have been added to achieve near 100% code coverage, ensuring robustness and reliability.
  • Code quality improvements: The refactoring also includes improvements to naming conventions and the reduction of method complexity.

Fixes # (issue)

Type of change

  • Refactoring (non-breaking change which improves code readability and maintainability)
  • New tests (non-breaking change which adds test coverage)

How Has This Been Tested?

  • Unit tests: Comprehensive unit tests have been added and executed to cover various scenarios, including edge cases.

Screenshots (if appropriate):

N/A

Checklist:

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works

@Freezor
Copy link
Author

Freezor commented May 16, 2024

@martafullen I created a unit test project and changelog for the commons module, so we can improve that common module and maybe get a better base for the package explorer and the server. This PR is my idea for a better structure. Let's discuss what you think about it.

@Freezor Freezor requested a review from martafullen May 28, 2024 09:28
@martafullen
Copy link
Contributor

I will have a looky 🙃

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants