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
Document how to write automated detector tests #69
Comments
Agreed! In the tradition of test-driven development (which @neiljp expertly enforced in the early days of this repo, much to our benefit!) it probably makes sense for writing tests to be the backbone of that tutorial document. I'll add this to my stack :) |
Might also make sense for this doc to live in the wiki so that we can update it without a full PR/review process. |
@j6k4m8, we are on the same page about test-driven development! Thanks for putting this on your stack. I'm taking the liberty of assigning this issue to you so that I remember. |
And I like the idea of putting this documentation in the wiki so that it is easier to keep up to date. I did that with another project and I think it works pretty well. The only reason I can think of to keep the developer docs in the code base would be if it helps remind contributors to update the docs when they update the code. |
Hmmm, that makes me wonder if we should go a step beyond test-driven development to do doc-driven development - a time-honored tradition in my field of human-computer interaction. |
There should be documentation of how to test a detector. Maybe this should go in or with the "how to write a detector" document. @j6k4m8 should weigh in on where this documentation belongs.
The text was updated successfully, but these errors were encountered: