Skip to content

Latest commit

 

History

History
10 lines (9 loc) · 1.16 KB

STYLEGUIDE.md

File metadata and controls

10 lines (9 loc) · 1.16 KB

#Данный документ содержит простые правила, которых надо придерживаться при написании кода

Необходимо:

  1. Использовать понятные переменные и константы. Не использовать переменные вида i, x, const и иные другие, которые не могут передать суть объекта, который в них передан
  2. Использовать тайпинги для функций
  3. Docstrings можно не использовать.
  4. Весь дублируемы код необходимо выносить в отдельные функции.
  5. Желательно избегать длинных, сложных, непонятных функций, делающих сразу много операций. Необходимо сегментировать код и присваивать функциям понятные названия
  6. Все переменные модели необходимо передавать через конфиг, а не через терминал