Skip to main content

Label Naming Rule

At Hyletic, we follow a consistent naming rule for labels. Label naming plays a crucial role in ensuring clarity, organization, and ease of use across different components of our platform. This guide provides an overview of the label naming rule that we adhere to.

Rules​

  1. In principle, as long as it is an epic or an issue, a label is necessary. After creating a new label, you need to update the label names and description in one or two docs, one is here and the other is board label description if your new label is process type label, which means this label can label your issues' current status.
  2. The abbreviation can only be used in the scope of the scoped label set. In principle, a single label cannot be written only with the abbreviation except for OKR type labels. List of abbreviations at the end of this page lists all abbreviations for details;
  3. Abbreviations need to use all uppercase English letters;
  4. The full name of the abbreviation must be included in the label description of the abbreviation;
  5. When the Label is a normal label instead of a scoped label, the first letter of a word needs to be capitalized, and for multiple words, the first letter of the first word shall prevail;
  6. In scoped label, all words and letters outside the scope are lowercase;
  7. When you need to add more labels, you can still use multiple "-" for word connections. The first letter of each word is always capitalized, and the abbreviation is always capitalized. 
Example: ENG-PHCM-Frontend.

List of abbreviations (in alphabetical order)​

  • ENG：Engineering
  • FY：Finance year 20
  • OKR：Objectives and Key Results
  • POG：People of Group

General Guidelines​

  1. Be Clear and Descriptive: Labels should accurately represent the purpose or function of the component they are applied to. It is essential to choose names that are clear, concise, and easily understandable by users.

  2. Consistency is Key: Ensure consistency in label naming across all components within the platform. Consistent naming conventions facilitate seamless navigation and understanding of the platform's functionalities.