General
What does the Z mean?
The Z, used as the plural S in the project names, came from the fact that the domain name jcoders.org had already been registered. The group decided to use Z for all plural forms in the future.
Where does the name fawkeZ come from?
The name fawkeZ was chosen when the project was released to the public internet. The previous name, phoeniX, was not unique enough to distinguish the project from many others with the same name. Fawkes is the name of a phoenix bird appearing in the Harry Potter universe.
JcReport
What does the quality percentage mean?
There is no special theory behind the quality percentage given in the report. The percentage should give a rough estimate and a way to compare packages, or to track changes within a package or project using a single number. It is not very accurate, but it does its job.
How is the percentage calculated?
The calculation works on the number of lines of code and on weighted finding counts. First the tool subtracts the weighted findings from the line count: coverage failures count once, warnings four times and errors twelve times. Informational findings have a weight of zero. If the result is negative, it is clamped to zero. The remaining value is then divided by the number of lines of code and multiplied by 100.
| Category | Weight |
|---|---|
| Info | 0 |
| Coverage failure | 1 |
| Warning | 4 |
| Error | 12 |
These weights were the configuration used by fawkeZ. A project can change them to match its own priorities. The summary report uses the same numbers when it plots the trend over time.
What is the meaning of the coloured bars in the report?
Why is the report split into test and production levels?
A finding in test code is usually less urgent than the same finding in production code. The report task supports separate file collections with a level attribute, and the level is written into the report XML so that findings can be filtered by origin.