generated from TBD54566975/tbd-project-template
-
Notifications
You must be signed in to change notification settings - Fork 5
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
Update Test Vector Readme With Example #80
Merged
Merged
Conversation
This file contains 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
nitro-neal
requested review from
decentralgabe,
mistermoe,
phoebe-lew,
frankhinek and
amika-sq
as code owners
December 14, 2023 23:32
amika-sq
approved these changes
Dec 19, 2023
andresuribe87
approved these changes
Dec 19, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small suggestions.
Co-authored-by: Andres Uribe <[email protected]>
Co-authored-by: Andres Uribe <[email protected]>
Co-authored-by: Andres Uribe <[email protected]>
Co-authored-by: Andres Uribe <[email protected]>
Co-authored-by: Andres Uribe <[email protected]>
Co-authored-by: Andres Uribe <[email protected]>
Co-authored-by: Andres Uribe <[email protected]>
Co-authored-by: Andres Uribe <[email protected]>
Co-authored-by: Andres Uribe <[email protected]>
Co-authored-by: Andres Uribe <[email protected]>
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.
Creating New Test Vector Full Walkthrough
Step 1: Create New Test Vector
Navigate to the GitHub repository: sdk-development[https://github.com/TBD54566975/sdk-development/tree/main/web5-test-vectors]
Create a new folder and JSON file with the structure example_feature/hello_world.json.
Populate the JSON file as follows:
Step 2: Copy JSON to Local Test-Vectors Directory
Copy the hello_world.json file from example_feature directory.
Place the copied file into the top level test-vectors directory of both web5-kt and web5-js projects.
Step 3: Create Unit Test in web5-kt
In the web5-kt project, create a new unit test class.
Name the class following the given pattern:
Prefix: Web5TestVectors
Middle: Convert example_feature to ExampleFeature (capitalize words and remove underscores)
Combined Output:
Web5TestVectorsExampleFeature
Step 4: Create Unit Test in web5-js
In the web5-js project, create a new unit test class.
Name the class following the given pattern:
Prefix: Web5TestVectors
Middle: Convert example_feature to ExampleFeature (capitalize words and remove underscores)
Combined Output:
Web5TestVectorsExampleFeature
Step 5: Completion
Your new test vector system is now set up and ready for use!