This PR resolves #16, highlighting that our unit test case names were not clear and could be confusing for new developers.
Key Changes
Clarified Test Case Names: Updated test case names and failure log messages to unambiguously indicate what each unit test is designed to verify.
Organized Tests with Describe Blocks: In line with Foundry's best practices, I've restructured the tests using describe blocks for method-level contracts. This change makes it easier to find tests related to specific methods.
Example:
Contract Add holds all unit tests for the add method of MyContract.
Contract Supply encompasses all tests for the supply method.
Contract Constructor includes all tests for the constructor function.
Optimized Import Statements: I have limited the import statements to only include necessary resources within modules. This optimization is aimed at avoiding unnecessary dependencies and potential errors with solc or solhint.
Additional Information
While the main focus of this PR is to resolve #16, I have also incorporated some best practices from Foundry where applicable to our project.
Description
Issue Resolved
This PR resolves #16, highlighting that our unit test case names were not clear and could be confusing for new developers.
Key Changes
Clarified Test Case Names: Updated test case names and failure log messages to unambiguously indicate what each unit test is designed to verify.
Organized Tests with Describe Blocks: In line with Foundry's best practices, I've restructured the tests using describe blocks for method-level contracts. This change makes it easier to find tests related to specific methods.
Optimized Import Statements: I have limited the import statements to only include necessary resources within modules. This optimization is aimed at avoiding unnecessary dependencies and potential errors with solc or solhint.
Additional Information
While the main focus of this PR is to resolve
#16
, I have also incorporated some best practices from Foundry where applicable to our project.Reference