init conventions
Created by: danwhale
Просьба в первую очередь уделить внимание корректному использованию стиля нэйминга переменных:
- для переменных и функций используется
snake_case
, если они приватные, используем только одно нижнее подчеркивание:_private_function
- для констант используем UPPER_SNAKE_CASE
- Для названий классов используем
UpperCamelCase
- Использовать только двойные кавычки при работе со строками
"
- в целом, линтерblack
будет исправлять их автоматически
Почитать: https://github.com/anpolol/StableGNN/blob/init_conventions/docs/Development.md
https://github.com/anpolol/StableGNN/tree/init_conventions#contribution
Также можно начинать писать докстринги по инструкции, которую я предоставил, обязательно познакомиться с тем, как работают линтеры в ридми секция Contribution
и попробовать их позапускать и пофиксить. Если написание докстринга не имеет смысла и функция не вызывается снаружи, можно просто сделать ее приватной и линтер не будет ругаться
Просьба все дальнейшие правки заливать не в ветку main
и делать пулл-реквест)