habitica/website/common/locales/en/gear_README.md
Matteo Pagliazzi 9a07ba7417
Better XSS Fix (#12483)
* Revert "fix(test): adjust expectations"

This reverts commit 205436d5b1.

* Revert "fix(escaping): global inoffensive apostrophe"

This reverts commit 2b8f94b244.

* change <%- to <%=

* fix interpolation only where necessary

* remove unused variable
2020-08-20 13:41:46 -05:00

1 KiB

Style Guide for Equipment Descriptions

To maintain consistency in equipment descriptions, the following guidelines have been proposed (https://github.com/HabitRPG/habitrpg-shared/pull/372):

Order of elements

  1. Description
  2. Stat Effect
  3. Event/Origin (if needed)

Stat Effect

  • No bonus: "Confers no benefit."
  • Single or all Stat bonus: "Increases (Strength/Intelligence/Constitution/Perception/all Stats) by (<%= str %>/<%= int %>/<%= con %>/<%= per %>/<%= attrs %>)."
  • Two Stats, same bonus: "Increases (Strength/Intelligence/Constitution) and (Intelligence/Constitution/Perception) by <%= attrs %> each."
  • Two Stats, different bonus: "Increases (Strength/Intelligence/Constitution) by (<%= str %>/<%= int %>/<%= con %>) and (Intelligence/Constitution/Perception) by (<%= int %>/<%= con %>/<%= per %>)]."

Event/Origin

Examples of wording:

  • "[Month] [Year] Subscriber Item." (e.g., "November 2014 Subscriber Item.")
  • "Limited Edition [Year] [Season] Gear." (e.g., "Limited Edition 2014 Spring Gear.")