General guidelines - OrderOfTheBee/addons GitHub Wiki

Requirement relevance types

For the sake of clarity, we should use consistent vocabulary based on RFC 2119 to clearly state the relevance / strictness of individual rules.

Any rule that uses "must" or "must not" is an absolute inclusive / exclusive requirement that leads to an addon not being included. Rules with "should" and "should not" are either qualitative or quantitative requirements that an addon may choose not to fulfill completely provided a reasonable argument can be made. An example may be "An addon should be compatible to at least one supported version of Microsoft Internet Explorer" which can be reasonably argued not to apply to an addon explicitly making use of functionality only supported in modern browsers (e.g. Web RTC). Any requirements defined using "may" are optional and do not exclude an addon from inclusion. Those requirements are to be understood as recommendations or best-practices aggregated from the committees experience in terms of developing, maintaining, administering or working as a user with Alfresco-based systems and addons.