2.7 KiB
2.7 KiB
Contributing to AstraDeploy
Спасибо за интерес к проекту! Любой вклад welcome: фиксы багов, улучшения UX, новые ядра, новые локали.
Как разрабатывать
- Склонируйте/проверьте локальный репозиторий.
- Работайте в отдельной ветке (рекомендуется).
- Изменения делайте минимальными и атомарными по смыслу.
- Смотрите локаль: тексты и подсказки лучше держать в
locales/*.sh, а не разбрасывать по скриптам.
Полезные принципы
install.shхранит общий lifecycle; ядра — вcores/*.sh.- Не меняйте поведение без флага по умолчанию, если это может сломать автоматический режим.
- Для новых параметров:
- добавьте парсинг в
install.sh; - добавьте локализацию в
locales/en.shиlocales/ru.sh; - проверьте сценарии
--yes,--easy,--dry-run,--force-clean,--accept-license.
- добавьте парсинг в
- При добавлении новых ядер:
- создайте новый файл в
cores/; - добавьте запись в
manifests/cores.json; - обновите
install.sh --helpсписок ядер.
- создайте новый файл в
Стиль и формат
- Bash: избегайте сложных однострочников, лучше явные переменные и функции.
- Локали и тексты: используйте существующие ключи/шаблоны в
locales. - Логи: новые важные шаги добавляйте через
info/warn/errorизlib/logger.sh.
Отладка и проверки
- Для быстрого прогона используйте
--dry-run. - При проблемах с внешним окружением:
--debugпокажет расширенные шаги;- просматривайте лог в
/var/log/astra-deploy/.
- Проверки не должны ломать установку на старте — лучше мягко предупреждать и продолжать fallback-логикой.
Pull Request
- Коротко опишите, что меняется и почему.
- Приложите сценарий проверки (команды/флаги), который вы прогоняли.
- Укажите совместимые ОС/ядра и известные ограничения.