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.

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

Create a test that ensures configuration is documented in README #42

Closed
Siegrift opened this issue Oct 26, 2023 · 0 comments · Fixed by #50
Closed

Create a test that ensures configuration is documented in README #42

Siegrift opened this issue Oct 26, 2023 · 0 comments · Fixed by #50
Assignees
@aquarat

Comments

@Siegrift
Copy link
Collaborator

Parse the README file and expect all configuration keys of the airseeker.example.json to be present.

This is a heuristic that should cover most of the cases of forgetting to write documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@aquarat aquarat

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Confirm README has all example config keys in it api3dao/airseeker
2 participants
@aquarat @Siegrift