Сделайте вклад

Будем признательны за любой вклад.

• Нам нужны люди в команду, которые будут читать тексты (которые пишутся) и помогать с проектом.
• Проходите опросы в канале
• Зайдите в чат канала и задавайте свои вопросы (или мне в личку)
• Проект находится, на гитхабе, пул-реквесты приветствуются.

Как работать с репозиторием

Скачайте luatex — sudo apt install texlive-latex-extra

Todo CLI

Так как сайт очень новый, не факт, что правила ниже верны :

Все скрипты протестированы только под linux, на другие системы аналогично, возможно будет работать. Вообще просто проверьте зависимости и сделайте ручками всё.

1. Установите cargo — curl https://sh.rustup.rs -sSf | sh, source "$HOME/.cargo/env".
2. Запустите скрипт local_installer.sh в папке utils для скачивания зависимостей mdbook'а и для скрипта simple-pre-commit.py, который приведёт код в хорошее состояние.
3. Запустите mdbook serve и сайт соберётся.
4. Сделайте изменения.
5. python3 utils/simple-pre-commit.py — обязательный скрипт.
6. Создайте PR.
7. Наша команда скорее всего примет ваши изменения.

Если у вас произошла ошибка, во время установки python зависимостей, то стоит использовать venv окружение.

Полезные скрипты (запуск из корня проекта):

• python3 utils/task-manager.py — создаёт .md файлы задач из папок.
• python3 utils/format.py — реформат кода
• yaspeller --config utils/.yaspeller.json . — спеллчекер.

python3 utils/simple-pre-commit.py запустит и линтер .md файлов, линтер питон скриптов, и task-manager.py d для удаления ненужный временных файлов.

Рекомендуется пройтись спеллчекером yaspeller. Для yaspeller-а у нашего проекта есть конфиг.

Как поднять свой сервер

Используйте максимально новую систему, с lld свежей, чтобы у вас бинарники собирались и тп =) Используйте Ubuntu-Ubuntu 22.04.1

Запустите скрипт local_installer.sh в папке utils, для скачивания зависимостей сервера.

Создайте файл secrets.json вида

{
    "USER": "...",
    "REPO": "....",
    "GH_PASSWORD": "ghp_...",
    "CICDHASH": "..." 
}

Поднимите сервер python3 -m uvicorn server:app --host 0.0.0.0 --port=8000

Стиль написания

Правила пока не особо соблюдаются.

Пишем всё культурно.

Для заголовков используем символ решётки. Для тем создаём папки. Файлы именуем по правилу:

• README.md первый файл темы
• Всё остальное
• Скорее всего надо сделать файл с задачами на эту тему. Это скорее страница со ссылками на уже созданные задачи в директории task.

Для функций в тексте и для всего подобного используем текст между апострофами.

Задаём все вопросы главным в проекте — мне (@i9kin), Диме (@insp3ctah), Коле (@Kiksnol), Алине (@shvedova_ali).

Благодарность

Спасибо всем кто вносил вклад в репозиторий проекта.

Люди перечисленны в случайном порядке:

• Я (@i9kin)
• Дима (@insp3ctah)
• Коля (@Kiksnol)
• Андрей (@AndrewKraevskii)
• Алина (@shvedova_ali)