[Request] Documentation of the various checks #107
Description
Endless Sky now has many checks in it. More than I can keep track of, so I suspect any new contributor will have trouble as well.
While some (compiling, and data content checks, for instance) are quite informative as to the errors they find, some of them are completely obtuse and provide no assistance whatsoever.
This request is that one or more pages be added to the wiki listing all our checks, with an explanation as to what each one is doing.
In the case of checks that do not provide specific information as to what failed, the wiki should provide a specific and detailed explanation information about what the check is checking, common or easy mistakes, and in the case of checks looking for something specific (such as the copyright header block) it should nail down exactly what it is looking for along with templates of acceptable examples.
The goal of these pages would be to provide someone with zero capability of reading or understanding the check code the ability to identify where they might be going wrong and rectify it. In other words, these pages should be human-readable detailed explanations of what the checks are checking, what will fail them, and how to pass them. In other words, something that a novice content contributor can use to rectify any errors that the checks flag.