Document how to write automated detector tests

Question

Document how to write automated detector tests

ProfJanetDavis opened this issue 4 years ago · comments

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.

Jordan Matelsky · Answer 1 · Fri Jun 26 2020 22:51:50 GMT+0800 (China Standard Time)

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 :)

Jordan Matelsky · Answer 2 · Fri Jun 26 2020 23:01:24 GMT+0800 (China Standard Time)

Might also make sense for this doc to live in the wiki so that we can update it without a full PR/review process.

Janet Davis · Answer 3 · Sat Jun 27 2020 03:13:17 GMT+0800 (China Standard Time)

@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.

Janet Davis · Answer 4 · Sat Jun 27 2020 03:15:46 GMT+0800 (China Standard Time)

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.

Janet Davis · Answer 5 · Sat Jun 27 2020 03:18:45 GMT+0800 (China Standard Time)

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.