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

Docs: Example config that is checked against parsing #84

Open

carlaKC opened this issue Aug 29, 2023 · 0 comments

Labels

documentation help wanted Low Priority

Contributor

carlaKC commented Aug 29, 2023

Broken readme configs suck. PRs to update configs also suck.

In an ideal one day world we would have:

An example config checked into the repo
That config is embedded in the readme
A unit test that parses the example config
A CI that fails if that test fails

carlaKC added documentation help wanted labels

carlaKC added this to the V1 Minor Improvements milestone

carlaKC added the Low Priority label

carlaKC removed this from the V1 Minor Improvements milestone

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