Skip to content

Commit

Permalink
Add link to the bufbuild/protobuf-conformance repository (#424)
Browse files Browse the repository at this point in the history
  • Loading branch information
timostamm authored Mar 13, 2023
1 parent 57947d6 commit 1b2033c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,8 @@ You should now see a generated file at `src/gen/example_pb.ts` that contains a c
Type-safe APIs with Protobuf and TypeScript.
* [connect-es-integration](https://github.com/bufbuild/connect-es-integration):
Examples for using Connect with various TypeScript web frameworks and tooling
* [protobuf-conformance](https://github.com/bufbuild/protobuf-conformance):
A repository running the Protobuf conformance tests against various libraries.
* [Buf Studio](https://studio.buf.build/): Web UI for ad-hoc RPCs
Expand Down
11 changes: 7 additions & 4 deletions packages/protobuf-conformance/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# Conformance tests

This package implements a testee for the protocol buffers [conformance test
suite](https://github.com/protocolbuffers/protobuf/tree/main/conformance).
suite](https://github.com/protocolbuffers/protobuf/tree/main/conformance) to
ensure completeness and correctness of the implementation.

The conformance tests run on code transpiled to ECMAScript modules.
If you would like to know how it stacks up compared to other implementations,
please take a look at the [protobuf-conformance repository](https://github.com/bufbuild/protobuf-conformance).

To cover the code path for our string-based fallback for 64-bit integers, the
conformance tests should be run with the environment variable

Note: To cover the code path for our string-based fallback for 64-bit integers,
the conformance tests should be run with the environment variable
`BUF_BIGINT_DISABLE=1`, which disables our BigInt feature detection.

0 comments on commit 1b2033c

Please sign in to comment.