Skip to content

Commit

Permalink
update vector docs to include auto PR sync stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
finn-tbd committed Dec 21, 2023
1 parent a875625 commit 75b7887
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions web5-test-vectors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,8 @@ Should `errors` be set to `true`, the `output` field may optionally be used to i

### Step 2: Copy JSON to Local Test-Vectors Directory

1. Copy the `hello_world.json` file from `example_feature` directory.

1. Place the copied file into the top level `test-vectors` directory of both `web5-kt` and `web5-js` projects.
Copy the `hello_world.json` file from `example_feature` directory into your SDK's test-vectors folder. make sure the file
and file name are both identical to that in the sdk-development repo.

### Step 3: Create Unit Test in web5-kt

Expand Down Expand Up @@ -129,6 +128,7 @@ class Web5TestVectorsExampleFeature {
### Step 5: Completion

* Once the above steps are completed, the `sdk-development` repository will automatically detect the new test vectors by consuming artifacts generated by a github action (No action by you required)
* Once the new vector merges into the sdk-development repo, PRs will be automatically opened on all SDKs that don't have it yet.
* The system will indicate whether the test passes or fails with a checkmark or an 'x'.

Your new test vector system is now set up and ready for use!

0 comments on commit 75b7887

Please sign in to comment.