@@ -42,7 +42,7 @@ been verified as valid testbed files until/unless more content is added to its c
4242Finally, the testGroupings folder should contain a list of folders that represent ''types'' of
4343content that may need to be verified or tested - e.g. ''environments'', ''answerables'' or ''authorship tools''.
4444More folders may be added here as we determine elements that are commonly needed to test together/in tandem.
45- Note that the intent here, is that the same test file may appear in multiple (indeed many) of these subfolders...
45+ Note that the intent here, is that the same test file may be referenced in multiple (many! ) of these subfolders...
4646since something like the `` \answer `` command is likely to show up under a lot of different categories of areas
4747that might need testing (e.g. ''student interactions'', ''page credit generating elements'', and
4848''javascript elements'' would all have the `` \answer `` command as a relevant test).
@@ -55,7 +55,7 @@ test files. To submit a new test file, see the section on ``Creating a New Test
5555
5656# Naming Schemes
5757
58- * ** Each test xourse is named after a dtx file and every dtx file has a test xourse .**
58+ * ** Each test xourse in the masterTestFolder is named after a dtx file.**
5959Since all development work must be implemented via dtx file (as per CTAN standards) and most development work
6060tends to involve only a few dtx files (usually just one or two), it is often easiest to test the new code by testing
6161everything that is implemented by the newly changed dtx code. This testing bed makes that easy to accomplish by merely
@@ -106,24 +106,24 @@ So just the ''problem'' related files would be in the structure as follows:
106106 - numbering.tex (demo/test for numbering scheme)
107107
108108# Creating a New Test File
109- If you have determined a meaningful test case that has no appropriate test file, you can do one of two things ;
109+ If you have determined a meaningful test case that has no appropriate test file, you can do the following ;
1101101 ) You should post the issue on the github issues tab of the example repo (** NOT** the ximeraLatex repo!) with
111111a detailed explanation of what you need to test - make sure to highlight exactly the things that need to be
112112tested that are not currently testable using the existing test files. In other words, make sure to include:
113- a) What is currently not able to be tested using existing test files.
114- b) What specifically you are trying to test overall (in the case that the part that is ` untestable ` is
113+ - What is currently not able to be tested using existing test files.
114+ - What specifically you are trying to test overall (in the case that the part that is ` untestable ` is
115115 only a piece of what you are trying to test overall).
116- c) Why you are trying to test and/or what you are trying to change about Ximera that needs testing.
116+ - Why you are trying to test and/or what you are trying to change about Ximera that needs testing.
1171172 ) Next - if you are able, you should make a branch of the main examples repo, and write your new test file.
118118Once you have the new test file written (and tested) and think it is ready to be merged, submit a pull request
119119with an explanation of what and how you are going about testing the thing you are submitting a new file for,
120120along with a reference to the github issue in the examples repo that you submitted from part 1. This will
121121allow another developer to quickly and easily review the file for submission and then merge it.
122- a) As a general rule, a different developer (than the author of the new file) should review/merge
122+ - As a general rule, a different developer (than the author of the new file) should review/merge
123123 a new test file for safety.
124- b) New test files should be verified to make sure they are necessary, suitably succinct in their testing,
124+ - New test files should be verified to make sure they are necessary, suitably succinct in their testing,
125125 and conform to the various naming and design requirements listed in this readme.
126- c) Once the merge has been completed, whomever reviewed the test file and merged the new test file into
126+ - Once the merge has been completed, whomever reviewed the test file and merged the new test file into
127127 the master test repo * must* be the one to close the github issue. This will help with quickly referencing
128128 who did what if there are any issues later on or if someone needs to verify something (helps minimize
129129 digging through the commit history).
0 commit comments