Processes
Content to be provided
Definitions
The following words, which are used throughout the Style Guide, are defined below:
-
canonical Prescriptive and enduring
Within this documentation, principles labeled as Canonical are considered a well defined standard processes that all developers should follow and that is not expected to change substantially over time. They should be understood by developers, testers, and reviewers alike, and there for must meet a high bar for comprehensibility.
-
reviewing Discussed and updated
Within this documentation, principles labeled as Reviewing are considered a standard processes that all developers should follow and that is not expected to change substantially over time. They should be understood by developers, testers, and reviewers alike, and there for must meet a high bar for comprehensibility.
-
normative Established and consistent
Within this documentation, principles labeled as Normative are agreed-upon standards of style for use by author and reviewers, in order that the suggestions, terminology, and justifications are consistent. These principles may change over time, and this documentation will reflect such changes so that reviewers can remain consistent and up-to-date.
-
proposed Documented and shared
Within this documentation, principles labeled Proposed are new principles that someone has suggested and the discussion is ongoing. Where possible, as long as you don’t strongly oppose the normative principle, follow that until such a the discussion is resolved and the rule is transitioned to Normative. Once it has transitioned, it will remain Normative long enough to be tested and analysed.
-
identified Unsure and incomplete
Within this documentation, principles labeled Identified are incomplete, where the need for a rule has been identified, but nothing has been compiled to support any stance on the matter. With no rule to follow, we are free to use our own best judgement to decide how to handle these situations.