Guidelines

Общие требования к документации и разработке проектов VarryalSoft.

Документация

• Основной формат — Markdown.
• Одна страница должна решать одну задачу и начинаться с заголовка первого уровня.
• Команды и конфигурации должны быть пригодны для копирования без скрытых шагов.
• Версионные ограничения Java, Minecraft, Fabric и Paper указываются явно.
• Ссылки между страницами должны быть относительными, если обе страницы входят в этот сайт.
• Секреты, адреса инфраструктуры и приватные ключи не добавляются в Git.

Runbooks

Каждый runbook должен содержать предусловия, последовательность действий, ожидаемый результат, проверку успешности и безопасный откат.