Если вы хотите помочь разработке проекта, пожалуйста, ознакомьтесь с приведёнными ниже рекомендациями.
Прочитайте, прежде чем вносить изменения.
- Используйте двойные кавычки вместо одинарных
- Используйте один символ табуляции для отступов.
- Не ставьте более двух пробелов подряд и не используйте табуляцию кроме как вначале строки для выделения отступов.
- Не оставляете пробельные символы на концах строк.
- Имена классов записываются с большой буквы каждое слово без подчёркиваний. Например,
ExampleOfNameClass. - Прочие идентификаторы записываются маленькими буквами с подчёркиванием в качестве разделителя слов. Например,
example_of_name_function. - Все пользовательские идентификаторы пишутся на английском языке. Если не знаете, как перевести слово, — загляните в словарь.
- Комментарии же можно оставлять как на русском языке, так и на английском.
- В остальном слушайтесь Гвидо и соблюдайте pep-8
Эта информация вам поможет соориентироваться в исходном коде программы. Если вы хотите внести вклад в разработку проекта, пожалуйста, соблюдайте эти соглашения.
- Размещайте связанные по смыслу классы в одном файле.
- Называете файл по имени основного класса, имена файлов записаны в нижнем регистре и имеют расширение
py. - Тесты кладите в папку /tests, тесты для одного модуля — в одном файле с соответсвующим названием.