Robust Testing Template #33
Description
The template was an initial pass about what kind of information we wanted to have in a given test file - mostly so that I could make a first pass to have a test file for each element from each dtx file. But this initial run was more about getting the vast majority of files created so that we could explore and discuss what kind of structure we wanted for the repo and testing mechanisms. The actual files themselves are definitely insufficient for testing files - and to that end we need to revisit the template (in the ximeraExamples/savedArchive/Templates/testFiles/ folder) to make it substantially more robust.
I will take a pass soon, and if others want to wait until they see what I do to get a better understanding then that is fine by me. The goal here though is for all the core developers to make a pass to add any universal test cases that should be tested for (more or less) every test element. There are obviously some elements that won't need all of these, but any test cases that apply to the vast majority of tested elements should be included.
As this is still the alpha stage, I'm fine with having people edit the files directly in main or making a branch for their own contributions and then coming up with their own lists/cases and presenting it in the meeting. Doing the branch method may be safer to avoid conflicts, but we should make sure to check in occasionally to minimize duplications between our respective lists - again I suspect this will be an iterative process, so either way is probably fine. Once we shift out of alpha, this is obviously something that would have to be submitted via the "add new content" workflow that we will develop (or probably Wim will develop since he's good at that kind of thing), as editing files directly in main is always a bad idea once we're out of alpha.
In spirit, the idea here is to capture the type of wrappers that a content author is likely to put ximera specific elements into. For example, we should make sure to have a test case for common styling environments in LaTeX (e.g. the "center" environment, "align", "enumerate", "itemize", etc), as well as mathmode (both the $ version and the \[ \] version). Then, for a given test file, we can include a "does not apply" note if a given test case doesn't apply to that test file element.
I suspect this will involve several meetings and iterations, so this issue should also serve as a flag for when we are in agreement that we have a satisfactory template - at which point we can close this issue.