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

Add benchmarks to our docs #57

Open
b5 opened this issue Oct 1, 2019 · 1 comment
Open

Add benchmarks to our docs #57

b5 opened this issue Oct 1, 2019 · 1 comment
Labels
docs help wanted Extra attention is needed

Comments

@b5
Copy link
Member

b5 commented Oct 1, 2019

@wildblueguy has done a great set of validator comparison benchmarks:
https://github.com/WildBlueGuy/validator-benchmarks

We should add benchmarks to our README.md that run just our version of that test suite so others can get a sense of the time it takes to validate a document.

Steps to Complete

  • fork this repo
  • pull the BenchmarkQri test from the wild blue's repo into a file called benchmark_test.go
  • add a commit using our commit guidelines. something like: test(benchmarks): incorporate benchmark test from WildBlueGuy validator comparison
  • execute the tests on your machine: go test --bench=. -v --run=XXX -benchmem
  • add the output to stats adding a shoutout to the validator-benchmarks repo for comparison
  • commit the readme changes, using some message like: docs(readme): add benchmarks to readme
  • file a PR!
@b5 b5 added help wanted Extra attention is needed docs labels Oct 1, 2019
@ghost
Copy link

ghost commented Oct 2, 2019

Hey that's me! Glad y'all are finding these useful. They got merged onto https://json-schema.org/implementations.html finally!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant