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 | 624e5a689563 | 2 |
Внесок
Дякуємо за ваш інтерес до участі. Цей посібник описує, як брати участь, що ми приймаємо і як розпочати.
Способи зробити внесок
Issue (не потребує налаштування)
- Звіти про помилки - Щось зламалося? Відкрийте звіт про помилку з кроками для відтворення.
- Запити на функції - Маєте ідею? Розпочніть обговорення, щоб спільнота могла висловитися та проголосувати за неї.
- Проблеми з перекладом - Помітили неправильний або відсутній переклад? Відкрийте issue про переклад.
- Проблеми з документацією - Щось не так у документації? Відкрийте issue про документацію.
Код (потребує CLA)
Ми приймаємо pull request-и для:
| Тип | Процес |
|---|---|
| Виправлення помилок | Відкрийте PR напряму (посилайтеся на issue, якщо він існує) |
| Нові переклади | Відкрийте PR напряму (див. Посібник з перекладу) |
| Покращення документації | Відкрийте PR напряму |
| Покращення тестового покриття | Відкрийте PR напряму |
| Нові інструменти чи функції | Спершу розпочніть обговорення; мейнтейнер перетворює схвалені ідеї на відстежуваний issue, перш ніж ви почнете писати код |
| Рефакторинг або зміни архітектури | Спершу розпочніть обговорення і дочекайтеся схвалення мейнтейнера, перш ніж писати код |
Що ми не приймемо
- Зміни у робочих процесах CI/CD, конфігурації випусків або конфігурації лінтера/компілятора
- PR-и без підписаної Угоди про ліцензування учасника
- PR-и з понад 400 рядками змін (розбийте велику роботу на менші PR-и)
- Функції, які не були попередньо обговорені та схвалені
- Зміни у
packages/ai/без попереднього обговорення
Угода про ліцензування учасника
Перш ніж ми зможемо влити ваш перший PR, ви маєте підписати нашу Індивідуальну CLA. Це одноразова вимога.
Чому: SnapOtter має подвійне ліцензування (AGPLv3 + комерційне). CLA надає нам право розповсюджувати ваші внески за обома ліцензіями. Ви зберігаєте повне авторське право на свою роботу.
Як: Коли ви відкриваєте свій перший PR, бот CLA Assistant залишить коментар із посиланням. Натисніть на нього, перегляньте угоду та підпишіть її своїм обліковим записом GitHub. Це займає 30 секунд.
Якщо ви робите внесок від імені свого роботодавця, і ваш роботодавець зберігає права інтелектуальної власності на вашу роботу, зверніться на contact@snapotter.com, щоб оформити корпоративну CLA перед надсиланням.
Початок роботи
Передумови
- Node.js 22.22+
- pnpm 9+
- Python 3.11+ (лише для інструментів ШІ)
- 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 влито
Ваш внесок буде включено до наступного випуску та зазначено у списку змін.
Хороші перші issue
Шукаєте, над чим попрацювати? Перегляньте наші хороші перші issue для завдань, зручних для початківців, або help wanted для більших завдань, де ми будемо вдячні за допомогу спільноти.
Стиль коду
- Biome відповідає за форматування та лінтинг (подвійні лапки, крапки з комою, відступ у 2 пробіли)
- Хук перед комітом автоматично запускає
biome check --writeна staged-файлах - Якщо лінтер скаржиться, виправте код (не змінюйте конфігурацію Biome)
- ES-модулі всюди (
import/export) - Conventional commits:
feat:,fix:,refactor:,docs:,test:,chore:
Повні деталі архітектури дивіться у Посібнику для розробників.
Безпека
Не відкривайте публічний PR чи issue щодо вразливостей безпеки. Повідомляйте про них приватно через GitHub Security Advisories або на пошту contact@snapotter.com. Повні деталі дивіться у SECURITY.md.