Внесок

Дякуємо за ваш інтерес до участі. Цей посібник описує, як брати участь, що ми приймаємо і як розпочати.

Способи зробити внесок

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 секунд.

Якщо ви робите внесок від імені свого роботодавця, і ваш роботодавець зберігає права інтелектуальної власності на вашу роботу, зверніться на [email protected], щоб оформити корпоративну CLA перед надсиланням.

Початок роботи

Передумови

• Node.js 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 :1349, 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-а

1. Зробіть форк репозиторію та створіть гілку від main (feat/my-feature або fix/issue-123)
2. Внесіть зміни зосередженими, придатними до рецензування комітами, використовуючи conventional commits
3. Додайте або оновіть тести для своїх змін
4. Запустіть pnpm lint && pnpm typecheck && pnpm test локально
5. Відкрийте PR проти main і заповніть шаблон
6. Підпишіть CLA, якщо буде запропоновано
7. Дочекайтеся проходження 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 або на пошту [email protected]. Повні деталі дивіться у SECURITY.md.

Питання?

• Документація
• Discord
• GitHub Discussions