Skip to content

Доработать кодгайд под новые JavaScript-критерии #69

Description

@sashasushko

В процессе переработки критериев мы поняли, что часть из них - это кодгайд, а не критерии качества. Поэтому как только работа над критериями будет завершена, нужно обновить кодгайд. И учесть в нём следующие "бывшие" критерии:

  • Правила, которые нужно расписать (по возможности переиспользовать тексты критериев)

    • Переменные названы по-английски, в единственном числе
    • Переменные, содержащие коллекции, именуются во множественном числе
    • Функции именуются с глагола
    • Константы записываются в нотации UPPER_SNAKE_CASE
    • Классы, функции-конструкторы и компоненты записываются в нотации PascalCase
    • Имена защищённых полей начинаются с подчёркивания, приватных — с решётки
  • Правила, которые можно упомянуть вскользь, потому что они автоматизируются

    • Имена функций, переменных, параметров, свойств и методов записываются в нотации camelCase
    • В названии переменных не используется тип данных (нет Венгерской нотации)
    • Название методов и свойств объектов не содержит название объектов. Нужно добавить про классы и их свойства и методы
    • Из названия обработчика события следует, что это обработчик. В Реакте может быть только on-схема, нужно придерживаться её везде
    • Константы нигде в коде не переопределяются
    • Код всех JS-файлов соответствует рекомендованной структуре. Нужно учесть особенность классов на JS-2 и Реакта

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions