search

Netcentric / aem-htl-style-guide

A style guide for the HTML Template Language (HTL), the templating language use by the Adobe Experience Manager (AEM).
MIT License
138 stars 50 forks source link

Unify recommendation language and syntax #32

Closed paulochang closed 4 months ago

paulochang commented 5 months ago

Sometimes we state a recommendation with "Always...." "Don't..." ... etc.

We should standardize the way we do recommendations. IMHO, the best way would be to use imperative statements, starting with a verb. Additionally, "always" is redundant, as we should always follow the recommendations or make it clear that something should be done "whenever possible". Similarly, instead of "Don't..." we can instead start with the imperative "Avoid...".

Finally, all references to code should be highlighted.

paulochang commented 4 months ago

Thanks! I'll merge and update my other PR's to follow the new conventions.