Стандарты написания кода распространяются на все файлы, которые создаются людьми, то есть на файлы исходного кода, черновики, документацию и т.д. Для каждого языка программирования или разметки эти стандарты отличаются, поэтому структура данного документа разбита на части, которые соответствуют каждому из языков, которые используются в проекте.
Тем не менее, ко всем файлам выдвигаются такие общие требования:
- Кодировка UTF-8 без BOM;
- Unix-переносы (LF). Установить такие настройки можно в любом современном текстовом редакторе (Atom, Brackets, emacs, Notepad++, Sublime Text, vim, Visual Studio Code и т.д.).
Язык разметки Markdown в этом проекте используется для оформления черновиков. В силу своего распространения этот язык имеет несколько вариаций. Так как данный проект поддерживается с помощью системы GitLab, то ознакомиться со специфической документацией можно в документации к системе GitLab в разделе Markdown.
При написании файлов исходного кода языка Python следует руководствоваться стандартом PEP8. Ознакомиться с текстом стандарта в более удобной форме также можно на специальном сайте.
TeX — это система компьютерной вёрстки, которая используется в данном проекте для подготовки документации в формате PDF. Для TeX не существуют общепринятые стандарты написания кода, но есть некоторые предложения и рекомендации. При написании TeX-файлов рекомендуется придерживаться именно их.