Skip to content

kysect/CodeRules

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Code rules

Данный репозиторий содержит набор правил, которые мы пытаемся соблюдать при написании проектов в Kysect.

Процедура добавления нового правила стиля / изменения существующего

  1. Создать новый Discussion.
  2. Описать ситуацию применения правила стиля:
    • Если стиль уже существует, прикрепить пермалинк существующих правил и сэмплов кода к дискуссии.
  3. Прикрепить сниппет с примером предложенного стиля (альтернативные варианты - опционально).
  4. По завершении дискуссии создать ишую со следующим содержанием:
    • Описание ситуации применения стиля;
    • Сниппет с примером кодстайла, полученного в ходе дискуссии;
    • Правила .editorconfig для настройки этих стилей.
  5. Создать пр со следующим содержанием:
    • Добавление правил настройки стилей в .editorconfig с документацией ситуации применения стиля (кратко, 1-2 строчки комментария);
    • Добавление сэмпла кода, если нововведённые правила не относятся к уже существующим сэмплам.

Важно

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

About

Code style and code rules for Kysect organization

Resources

License

Stars

Watchers

Forks