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.

Sign up for GitHub

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

Jump to bottom

Investigate effort to test readme code snippets #511

Open

bvotteler opened this issue Dec 21, 2022 · 0 comments

Labels

Contributor

bvotteler commented Dec 21, 2022

Investigate how much effort it takes to add tests for code snippets in our readmes to be tested using this library:
https://github.com/bbc/typescript-docs-verifier

The goal is to be able to fail a test if our code changes in such a way that documented snippets are wrong and need updating.

bvotteler added the prio:low label

nud3l added this to Backlog

nud3l moved this to Todo ⏳ in Backlog

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment