Skip to content

Issue Reporting Guide

Damian Crosby edited this page Apr 8, 2018 · 6 revisions

To aid in efficient issue management, please use the following tagging system when posting an issue:

Enhancements

Use the enhancement tag for all suggestions of improvements. Please check the Roadmap beforehand to make sure it isn't already on there.

Problems

  • Use the won't compile tag for anything that causes one or more errors in the compiler (i.e. stops the compilation process). Please post your markup and the errors from the output console.
  • Use the bad compile tag for anything that, while not producing compiler errors, results in a cleary incorrect result (e.g. poor alignment, missing text or glyphs). Please post your markup and a screenshot of the result.
  • Use the typo tag for any spelling errors. Please note the syntax currently uses UK English.
  • Use the not to standard tag for anything (text, glyph or symbol construction) that you believe does not conform to the guidelines set out in APP-6(C). Please only post this issue if you are reasonably certain the current item is incorrect, and provide a detailed description and/or visual example of the correction required.
  • Use the documentation tag for anything concerning the manual. Use this tag along with another tag to indicate the problem.
Clone this wiki locally