SnapOtterandGitHub
d10d0f544f
A release-readiness QA pass over the whole product. The commits split into defects a user would hit and gates that were reporting green while measuring nothing. ## Fixes that change behaviour Rate limiting was bypassable on every install: TRUST_PROXY defaulted to true, so request.ip came from a client-set header and a forged X-Forwarded-For got past the login limiter. The default is now a private-network trust list. A transient Postgres outage stranded in-flight jobs, leaving finished output on disk with no row pointing at it. A reconciler now resolves those rows and adopts the bytes rather than dropping the work. A Redis connection that moved to a new address wedged every read-blocked consumer, so completions stopped signalling while health still answered 200. Socket timeouts plus subscriber pings recover it. Installing more than one AI bundle left the shared venv multi-versioned and silently broke three tools. The installer now reconciles distributions to one version each. Converting an image to JXL at quality 1 through 4 returned a 500, because libjxl 0.7 rejects the distance those values compute. The quality is floored at what the encoder honours. A missing ffmpeg was also reported to the user as a corrupt upload; it now says the engine is unavailable. RAW uploads reached an unpatched LibRaw on arm64, so it is built from source at 0.22.2, and the release scan was split so it can fail on an unfixed critical instead of hiding it behind ignore-unfixed. ## Gates that could not fail Two mutation lanes ran zero mutants because Stryker crawled the gitignored docs build; coverage discarded its whole report on any failing test; the lint gate skipped root tests, scripts, and two workspaces; and several generated matrices counted a host missing ffmpeg as a passing tool. Each now measures what it claims. Full evidence and the outstanding release items are tracked locally and are not part of this branch.
9.5 KiB
description, i18n_source_hash, i18n_provenance, i18n_output_hash, i18n_hash_version
| description | i18n_source_hash | i18n_provenance | i18n_output_hash | i18n_hash_version |
|---|---|---|---|---|
| Как участвовать в развитии SnapOtter. Отчёты об ошибках, запросы функций, pull request'ы и требования CLA. | 6c920a5f83e0 | human | ad5af3c27b23 | 2 |
Участие
Спасибо за интерес к участию в проекте. Это руководство описывает, как участвовать, что мы принимаем и с чего начать.
Способы участия
Issues (без настройки)
- Отчёты об ошибках - Что-то сломалось? Откройте отчёт об ошибке с шагами воспроизведения.
- Запросы функций - Есть идея? Начните обсуждение, чтобы сообщество могло высказаться и проголосовать за неё.
- Проблемы с переводом - Заметили неверный или отсутствующий перевод? Откройте issue о переводе.
- Проблемы с документацией - Что-то не так в документации? Откройте issue о документации.
Код (требует CLA)
Мы принимаем pull request'ы для:
| Тип | Процесс |
|---|---|
| Исправления ошибок | Откройте PR напрямую (сошлитесь на issue, если он есть) |
| Новые переводы | Откройте PR напрямую (см. руководство по переводу) |
| Улучшения документации | Откройте PR напрямую |
| Улучшения покрытия тестами | Откройте PR напрямую |
| Новые инструменты или функции | Сначала начните обсуждение; мейнтейнер превращает одобренные идеи в отслеживаемый issue до того, как вы начнёте писать код |
| Рефакторинг или изменения архитектуры | Сначала начните обсуждение и дождитесь одобрения мейнтейнера перед написанием кода |
Что мы не принимаем
- Изменения в CI/CD-пайплайнах, конфигурации релизов или конфигурации линтера/компилятора
- PR'ы без подписанного Contributor License Agreement
- PR'ы с изменениями более чем на 400 строк (разбивайте большую работу на меньшие PR'ы)
- Функции, которые не были предварительно обсуждены и одобрены
- Изменения в
packages/ai/без предварительного обсуждения
Contributor License Agreement
Прежде чем мы сможем принять ваш первый PR, вы должны подписать наше индивидуальное CLA. Это одноразовое требование.
Почему: SnapOtter распространяется под двойной лицензией (AGPLv3 + коммерческая). CLA предоставляет нам право распространять ваш вклад под обеими лицензиями. Вы сохраняете полное авторское право на свою работу.
Как: Когда вы откроете свой первый PR, бот CLA Assistant оставит комментарий со ссылкой. Нажмите на неё, ознакомьтесь с соглашением и подпишите его своей учётной записью GitHub. Это займёт 30 секунд.
Если вы вносите вклад от имени работодателя и он сохраняет права на интеллектуальную собственность в отношении вашей работы, свяжитесь с contact@snapotter.com, чтобы оформить корпоративное CLA перед отправкой.
Начало работы
Предварительные требования
- Node.js 22.22+
- pnpm 9+
- Python 3.11+ (только для AI-инструментов)
- Docker (опционально, для полного интеграционного тестирования)
Настройка
# Fork and clone
git clone https://github.com/<your-username>/snapotter.git
cd snapotter
# Start Postgres + Redis for local dev
docker compose -f docker-compose.dev.yml up -d
# Install dependencies
pnpm install
# Start dev servers (web on :1351, API on :13490)
pnpm dev
Запуск проверок
Перед отправкой PR убедитесь, что все проверки проходят локально:
pnpm lint # Biome lint + format check
pnpm typecheck # TypeScript across monorepo
pnpm test # Vitest unit + integration tests
Процесс pull request
- Сделайте форк репозитория и создайте ветку от
main(feat/my-featureилиfix/issue-123) - Вносите изменения сфокусированными, пригодными для ревью коммитами, используя conventional commits
- Добавьте или обновите тесты для своих изменений
- Запустите
pnpm lint && pnpm typecheck && pnpm testлокально - Откройте PR против
mainи заполните шаблон - Подпишите CLA, если будет предложено
- Дождитесь прохождения CI и ревью от мейнтейнера
Ожидания по ревью
- Мы стремимся отвечать на PR'ы в течение 7 дней
- Небольшие, сфокусированные PR'ы проходят ревью быстрее
- Если вы не получили ответа в течение 7 дней, оставьте комментарий с упоминанием в треде
- Мы можем запросить изменения, предложить другой подход или закрыть PR, если он не соответствует направлению проекта
После того как ваш PR будет принят
Ваш вклад войдёт в следующий релиз и будет упомянут в списке изменений.
Хорошие первые задачи
Ищете, над чем поработать? Загляните в наши хорошие первые задачи, подходящие для новичков, или в help wanted для более крупных задач, где мы будем рады помощи сообщества.
Стиль кода
- Biome отвечает за форматирование и линтинг (двойные кавычки, точки с запятой, отступ в 2 пробела)
- Pre-commit-хук автоматически запускает
biome check --writeна staged-файлах - Если линтер ругается, исправляйте код (не изменяйте конфигурацию Biome)
- ES-модули везде (
import/export) - Conventional commits:
feat:,fix:,refactor:,docs:,test:,chore:
Полные детали архитектуры смотрите в руководстве разработчика.
Безопасность
Не открывайте публичный PR или issue для уязвимостей безопасности. Сообщайте о них приватно через GitHub Security Advisories или по email contact@snapotter.com. Полные детали смотрите в SECURITY.md.