Repository navigation
doc: Add comprehensive testing documentation - #16
Merged
Merged
Conversation
Contributor
Author
|
@phertyameen Please review |
phertyameen
requested changes
Jan 22, 2026
Contributor
Author
|
@phertyameen Updated! |
phertyameen
approved these changes
Jan 22, 2026
5 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a complete testing guide (
docs/testing.md) that documents how to run tests, write new tests, and understand the testing strategy for Bridgelet Core smart contracts.What's Included
📚 Documentation Sections
Key Features
✅ Clear and Reproducible Instructions - All commands are tested and verified
✅ Working Examples - Code examples based on actual test files in the codebase
✅ Complete Coverage - Covers all testing scenarios (unit, integration, sandbox)
✅ Helpful Troubleshooting - Comprehensive solutions for common problems
✅ Best Practices - Guidelines for writing maintainable tests
Files Changed
docs/testing.md- New comprehensive testing documentation (527 lines)Testing
The documentation includes examples that match the existing test structure:
contracts/ephemeral_account/src/test.rscontracts/sweep_controller/tests/integration.rsAll commands and examples have been verified against the current codebase structure.
Acceptance Criteria Met
docs/testing.mdfile existsRelated
Addresses the need for comprehensive testing documentation as referenced in the main README.md.
Closes #11