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

Typo Corrections testing.md / README.md #8107

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

futreall
Copy link

@futreall futreall commented Nov 8, 2024

Description

This pull request includes several documentation updates and code fixes to improve code quality and readability. Specifically:

  • Updated links and corrected typos in testing.md and README.md to ensure documentation accuracy.
  • Modified mockAxios in test files to return Userdata instead of data, matching expected types and improving test reliability.
  • Adjusted variable names in caip/README.md to ensure consistent naming, reducing potential confusion for developers referencing the documentation.

Risk

Low

This PR is categorized as low risk, as it primarily involves updates to documentation and test configurations. No on-chain transactions or core state management changes are introduced. These changes do not impact any production code directly but improve test readability and consistency.

What protocols, transaction types, wallets or contract interactions might be affected by this PR?

None.

Engineering

To verify these changes:

  1. Run the test suite to ensure all tests pass with the updated mockAxios return values.
  2. Review the modified README.md and testing.md documentation for accuracy and consistency.

Operations

  • 🏁 My feature is behind a flag and doesn't require operations testing (yet)

No user-facing impact; changes are confined to developer documentation and test configuration. No additional operational testing is required.

Fixed account comparison in tests

Enclosed the account address in quotes to ensure it's treated as a string:
Changed expect(account).toEqual(0xa44c286ba83bb771cd0107b2c1df678435bd1535) to expect(account).toEqual('0xa44c286ba83bb771cd0107b2c1df678435bd1535')
- Removed the duplicate "react testing library" link.
- Corrected the test name in `useIsComponentMounted` to `it('should be false on unmount', ...)`.
- Replaced `data` with `UserData` in the `mockUserData` function.
@futreall futreall requested a review from a team as a code owner November 8, 2024 15:50
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.

1 participant