OmniRoute/docs/i18n/tr/CONTRIBUTING.md

Contributing to OmniRoute (Türkçe)

🌐 Languages: 🇺🇸 English · 🇪🇸 es · 🇫🇷 fr · 🇩🇪 de · 🇮🇹 it · 🇷🇺 ru · 🇨🇳 zh-CN · 🇯🇵 ja · 🇰🇷 ko · 🇸🇦 ar · 🇮🇳 hi · 🇮🇳 in · 🇹🇭 th · 🇻🇳 vi · 🇮🇩 id · 🇲🇾 ms · 🇳🇱 nl · 🇵🇱 pl · 🇸🇪 sv · 🇳🇴 no · 🇩🇰 da · 🇫🇮 fi · 🇵🇹 pt · 🇷🇴 ro · 🇭🇺 hu · 🇧🇬 bg · 🇸🇰 sk · 🇺🇦 uk-UA · 🇮🇱 he · 🇵🇭 phi · 🇧🇷 pt-BR · 🇨🇿 cs · 🇹🇷 tr

---

Katkıda bulunmaya gösterdiğiniz ilgi için teşekkür ederiz! Bu kılavuz, başlamak için ihtiyacınız olan her şeyi kapsar.---

Development Setup

Prerequisites

-Node.js>= 18 < 24 (önerilen: 22 LTS) -npm10+ -Git### Clone & Install

git clone https://github.com/diegosouzapw/OmniRoute.git
cd OmniRoute
npm install

Environment Variables

# Create your .env from the template
cp .env.example .env

# Generate required secrets
echo "JWT_SECRET=$(openssl rand -base64 48)" >> .env
echo "API_KEY_SECRET=$(openssl rand -hex 32)" >> .env

Gelişim için temel değişkenler:

Değişken	Geliştirme Varsayılanı	Açıklama
'LİMAN'	'20128'	Sunucu bağlantı noktası
'NEXT_PUBLIC_BASE_URL'	'http://localhost:20128'	Ön uç için temel URL
'JWT_SECRET'	(yukarıda oluşturun)	JWT imzalama sırrı
INITIAL_PASSWORD	'DEĞİŞTİR'	İlk giriş şifresi
'APP_LOG_LEVEL'	'bilgi'	Günlük ayrıntı düzeyi	### Dashboard Settings

Kontrol paneli, ortam değişkenleri yoluyla da yapılandırılabilen özellikler için kullanıcı arayüzü geçişleri sağlar:

Konum Ayarlama	Değiştir	Açıklama
Ayarlar → Gelişmiş	Hata Ayıklama Modu	Hata ayıklama isteği günlüklerini etkinleştirin (UI)
Ayarlar → Genel	Kenar Çubuğu Görünürlüğü	Kenar çubuğu bölümlerini göster/gizle

Bu ayarlar veritabanında saklanır ve ayarlandığında env var varsayılanlarını geçersiz kılarak yeniden başlatmalarda kalıcı olur.### Running Locally

# Development mode (hot reload)
npm run dev

# Production build
npm run build
npm run start

# Common port configuration
PORT=20128 NEXT_PUBLIC_BASE_URL=http://localhost:20128 npm run dev

Varsayılan URL'ler:

-Kontrol Paneli: http://localhost:20128/dashboard -API: http://localhost:20128/v1---

Git Workflow

⚠️**ASLA doğrudan "ana"ya bağlanma.**Her zaman özellik dallarını kullanın.```bash git checkout -b feat/your-feature-name

... make changes ...

git commit -m "feat: describe your change" git push -u origin feat/your-feature-name

Open a Pull Request on GitHub

### Branch Naming

| Önek | Amaç |
| ----------- | ------------------------- |
| `feat/` | Yeni özellikler |
| 'düzelt/' | Hata düzeltmeleri |
| 'yeniden düzenleyen/' | Kodun yeniden yapılandırılması |
| 'dokümanlar/' | Dokümantasyon değişiklikleri |
| 'deneme/' | Eklemeleri/düzeltmeleri test edin |
| `angarya/' | Araçlar, CI, bağımlılıklar |### Commit Messages

[Geleneksel Taahhütleri](https://www.conventionalcommits.org/) takip edin:```
feat: add circuit breaker for provider calls
fix: resolve JWT secret validation edge case
docs: update SECURITY.md with PII protection
test: add observability unit tests
refactor(db): consolidate rate limit tables

Kapsamlar: 'db', 'sse', 'oauth', 'dashboard', 'api', 'cli', 'docker', 'ci', 'mcp', 'a2a', 'bellek', 'beceriler'.---

Running Tests

# All tests (unit + vitest + ecosystem + e2e)
npm run test:all

# Single test file (Node.js native test runner — most tests use this)
node --import tsx/esm --test tests/unit/your-file.test.mjs

# Vitest (MCP server, autoCombo, cache)
npm run test:vitest

# E2E tests (requires Playwright)
npm run test:e2e

# Protocol clients E2E (MCP transports, A2A)
npm run test:protocols:e2e

# Ecosystem compatibility tests
npm run test:ecosystem

# Coverage (60% min statements/lines/functions/branches)
npm run test:coverage
npm run coverage:report

# Lint + format check
npm run lint
npm run check

Kapsam notları:

• "npm çalıştırma testi:kapsam", ana ünite test takımı için kaynak kapsamını ölçer, "testler/"i hariç tutar ve "açık-sse/"yi içerir
• Çekme istekleri, ekstreler, satırlar, işlevler ve dallar için genel kapsam kapısını**%60 veya daha yüksek**olarak tutmalıdır
• Bir PR, "src/", "open-sse/", "electron/" veya "bin/" üretim kodunu değiştirirse, aynı PR'ye otomatik testler eklemeli veya güncellemelidir
• npm çalıştırma kapsamı:rapor, en son kapsama çalıştırmasından dosya bazında ayrıntılı raporu yazdırır
• npm çalıştırma testi:kapsam:eski, geçmiş karşılaştırma için eski ölçümü korur
• Aşamalı kapsamı iyileştirme yol haritası için docs/COVERAGE_PLAN.mdye bakın### Pull Request Requirements

Bir PR'yi açmadan veya birleştirmeden önce:

• 'npm run test:unit'i çalıştırın
• 'npm çalıştırma testi:kapsam'ı çalıştırın
• Tüm metrikler için kapsama kapısının**%60+**'da kalmasını sağlayın
• Üretim kodu değiştiğinde değiştirilen veya eklenen test dosyalarını PR açıklamasına ekleyin
• Proje gizli dizileri CI'da yapılandırıldığında PR'deki SonarQube sonucunu kontrol edin

Mevcut test durumu:122 birim test dosyasışunları kapsar:

• Sağlayıcı çevirmenleri ve format dönüştürme
• Hız sınırlama, devre kesici ve esneklik
• Anlamsal önbellek, yetersizlik, ilerleme takibi
• Veritabanı işlemleri ve şeması (21 DB modülü)
• OAuth akışları ve kimlik doğrulama
• API uç nokta doğrulaması (Zod v4)
• MCP sunucu araçları ve kapsam uygulaması
• Hafıza ve Beceri sistemleri---

Code Style

-ESLint— İşlemden önce npm run lint'i çalıştırın -**Daha güzel**— İşleme sırasında "lint-staged" aracılığıyla otomatik biçimlendirilmiş (2 boşluk, noktalı virgül, çift tırnak, 100 karakter genişliği, es5 sondaki virgüller) -**TypeScript**— Tüm src/kodları.ts/.tsxkullanır;open-sse/, .ts/.jsyi kullanır; TSDoc içeren belge ("@param, @returns, @throws) -'eval()' yok— ESLint, "değerlendirme yok", "ima edilen değerlendirme yok", "yeni-işlev yok" özelliklerini uygular -Zod doğrulama— Tüm API giriş doğrulaması için Zod v4 şemalarını kullanın -Adlandırma: Dosyalar = camelCase/kebab-case, bileşenler = PascalCase, sabitler = UPPER_SNAKE---

Project Structure

src/                        # TypeScript (.ts / .tsx)
├── app/                    # Next.js 16 App Router
│   ├── (dashboard)/        # Dashboard pages (23 sections)
│   ├── api/                # API routes (51 directories)
│   └── login/              # Auth pages (.tsx)
├── domain/                 # Policy engine (policyEngine, comboResolver, costRules, etc.)
├── lib/                    # Core business logic (.ts)
│   ├── a2a/                # Agent-to-Agent v0.3 protocol server
│   ├── acp/                # Agent Communication Protocol registry
│   ├── compliance/         # Compliance policy engine
│   ├── db/                 # SQLite database layer (21 modules + 16 migrations)
│   ├── memory/             # Persistent conversational memory
│   ├── oauth/              # OAuth providers, services, and utilities
│   ├── skills/             # Extensible skill framework
│   ├── usage/              # Usage tracking and cost calculation
│   └── localDb.ts          # Re-export layer only — never add logic here
├── middleware/              # Request middleware (promptInjectionGuard)
├── mitm/                   # MITM proxy (cert, DNS, target routing)
├── shared/
│   ├── components/         # React components (.tsx)
│   ├── constants/          # Provider definitions (60+), MCP scopes, routing strategies
│   ├── utils/              # Circuit breaker, sanitizer, auth helpers
│   └── validation/         # Zod v4 schemas
└── sse/                    # SSE proxy pipeline

open-sse/                   # @omniroute/open-sse workspace
├── executors/              # 14 provider-specific request executors
├── handlers/               # 11 request handlers (chat, responses, embeddings, images, etc.)
├── mcp-server/             # MCP server (25 tools, 3 transports, 10 scopes)
├── services/               # 36+ services (combo, autoCombo, rateLimitManager, etc.)
├── translator/             # Format translators (OpenAI ↔ Claude ↔ Gemini ↔ Responses ↔ Ollama)
├── transformer/            # Responses API transformer
└── utils/                  # 22 utility modules (stream, TLS, proxy, logging)

electron/                   # Electron desktop app (cross-platform)

tests/
├── unit/                   # Node.js test runner (122 test files)
├── integration/            # Integration tests
├── e2e/                    # Playwright tests
├── security/               # Security tests
├── translator/             # Translator-specific tests
└── load/                   # Load tests

docs/                       # Documentation
├── ARCHITECTURE.md         # System architecture
├── API_REFERENCE.md        # All endpoints
├── USER_GUIDE.md           # Provider setup, CLI integration
├── TROUBLESHOOTING.md      # Common issues
├── MCP-SERVER.md           # MCP server (25 tools)
├── A2A-SERVER.md           # A2A agent protocol
├── AUTO-COMBO.md           # Auto-combo engine
├── CLI-TOOLS.md            # CLI tools integration
├── COVERAGE_PLAN.md        # Test coverage improvement plan
├── openapi.yaml            # OpenAPI specification
└── adr/                    # Architecture Decision Records

---

Adding a New Provider

Step 1: Register Provider Constants

'src/shared/constants/providers.ts' dosyasına ekleyin — Modül yükünde Zod tarafından doğrulandı.### Step 2: Add Executor (if custom logic needed)

'open-sse/executors/your-provider.ts' dosyasında temel yürütücüyü genişleterek yürütücü oluşturun.### Step 3: Add Translator (if non-OpenAI format)

'Open-sse/translator/'da istek/yanıt çevirmenleri oluşturun.### Step 4: Add OAuth Config (if OAuth-based)

OAuth kimlik bilgilerini "src/lib/oauth/constants/oauth.ts" içine ve hizmeti "src/lib/oauth/services/" içine ekleyin.### Step 5: Register Models

'open-sse/config/providerRegistry.ts' dosyasına model tanımlarını ekleyin.### Step 6: Add Tests

Birim testlerini en azından aşağıdakileri kapsayacak şekilde "testler/birim/" olarak yazın:

• Sağlayıcı kaydı
• İstek/yanıt çevirisi
• Hata işleme---

Pull Request Checklist

• Testler başarılı (npm testi)
• Linting geçişleri (npm run lint)
• Derleme başarılı ('npm run build')
• Yeni genel işlevler ve arayüzler için TypeScript türleri eklendi
• Sabit kodlanmış sırlar veya geri dönüş değerleri yok
• Tüm girişler Zod şemalarıyla doğrulandı
• CHANGELOG güncellendi (kullanıcının karşılaştığı bir değişiklik varsa)
• Belgeler güncellendi (varsa)---

Releasing

Sürümler, '/generate-release' iş akışı aracılığıyla yönetilir. Yeni bir GitHub Sürümü oluşturulduğunda, paket GitHub Eylemleri aracılığıylaotomatik olarak npm'ye yayınlanır.---

Getting Help

-Mimarlık: Bkz. docs/ARCHITECTURE.md -API Referansı: Bkz. docs/API_REFERENCE.md -Sorunlar: github.com/diegosouzapw/OmniRoute/issues -ADR'ler: Mimari karar kayıtları için bkz. "belgeler/adr/"