# Contributing to OmniRoute (Gaeilge)

🌐 **Languages:** 🇺🇸 [English](../../../CONTRIBUTING.md) · 🇪🇹 [am](../am/CONTRIBUTING.md) · 🇸🇦 [ar](../ar/CONTRIBUTING.md) · 🇦🇿 [az](../az/CONTRIBUTING.md) · 🇧🇬 [bg](../bg/CONTRIBUTING.md) · 🇧🇩 [bn](../bn/CONTRIBUTING.md) · 🇧🇦 [bs](../bs/CONTRIBUTING.md) · 🇨🇿 [cs](../cs/CONTRIBUTING.md) · 🇩🇰 [da](../da/CONTRIBUTING.md) · 🇩🇪 [de](../de/CONTRIBUTING.md) · 🇬🇷 [el](../el/CONTRIBUTING.md) · 🇪🇸 [es](../es/CONTRIBUTING.md) · 🇪🇪 [et](../et/CONTRIBUTING.md) · 🇮🇷 [fa](../fa/CONTRIBUTING.md) · 🇫🇮 [fi](../fi/CONTRIBUTING.md) · 🇫🇷 [fr](../fr/CONTRIBUTING.md) · 🇮🇳 [gu](../gu/CONTRIBUTING.md) · 🇳🇬 [ha](../ha/CONTRIBUTING.md) · 🇮🇱 [he](../he/CONTRIBUTING.md) · 🇮🇳 [hi](../hi/CONTRIBUTING.md) · 🇭🇷 [hr](../hr/CONTRIBUTING.md) · 🇭🇺 [hu](../hu/CONTRIBUTING.md) · 🇦🇲 [hy](../hy/CONTRIBUTING.md) · 🇮🇩 [id](../id/CONTRIBUTING.md) · 🇳🇬 [ig](../ig/CONTRIBUTING.md) · 🇮🇹 [it](../it/CONTRIBUTING.md) · 🇯🇵 [ja](../ja/CONTRIBUTING.md) · 🇬🇪 [ka](../ka/CONTRIBUTING.md) · 🇰🇭 [km](../km/CONTRIBUTING.md) · 🇮🇳 [kn](../kn/CONTRIBUTING.md) · 🇰🇷 [ko](../ko/CONTRIBUTING.md) · 🇱🇹 [lt](../lt/CONTRIBUTING.md) · 🇱🇻 [lv](../lv/CONTRIBUTING.md) · 🇮🇳 [ml](../ml/CONTRIBUTING.md) · 🇮🇳 [mr](../mr/CONTRIBUTING.md) · 🇲🇾 [ms](../ms/CONTRIBUTING.md) · 🇲🇹 [mt](../mt/CONTRIBUTING.md) · 🇲🇲 [my](../my/CONTRIBUTING.md) · 🇳🇵 [ne](../ne/CONTRIBUTING.md) · 🇳🇱 [nl](../nl/CONTRIBUTING.md) · 🇳🇴 [no](../no/CONTRIBUTING.md) · 🇮🇳 [or](../or/CONTRIBUTING.md) · 🇮🇳 [pa](../pa/CONTRIBUTING.md) · 🇵🇭 [phi](../phi/CONTRIBUTING.md) · 🇵🇱 [pl](../pl/CONTRIBUTING.md) · 🇵🇹 [pt](../pt/CONTRIBUTING.md) · 🇧🇷 [pt-BR](../pt-BR/CONTRIBUTING.md) · 🇷🇴 [ro](../ro/CONTRIBUTING.md) · 🇷🇺 [ru](../ru/CONTRIBUTING.md) · 🇱🇰 [si](../si/CONTRIBUTING.md) · 🇸🇰 [sk](../sk/CONTRIBUTING.md) · 🇸🇮 [sl](../sl/CONTRIBUTING.md) · 🇷🇸 [sr](../sr/CONTRIBUTING.md) · 🇸🇪 [sv](../sv/CONTRIBUTING.md) · 🇰🇪 [sw](../sw/CONTRIBUTING.md) · 🇮🇳 [ta](../ta/CONTRIBUTING.md) · 🇮🇳 [te](../te/CONTRIBUTING.md) · 🇹🇭 [th](../th/CONTRIBUTING.md) · 🇹🇷 [tr](../tr/CONTRIBUTING.md) · 🇺🇦 [uk-UA](../uk-UA/CONTRIBUTING.md) · 🇵🇰 [ur](../ur/CONTRIBUTING.md) · 🇺🇿 [uz](../uz/CONTRIBUTING.md) · 🇻🇳 [vi](../vi/CONTRIBUTING.md) · 🇳🇬 [yo](../yo/CONTRIBUTING.md) · 🇨🇳 [zh-CN](../zh-CN/CONTRIBUTING.md) · 🇹🇼 [zh-TW](../zh-TW/CONTRIBUTING.md)

---

Go raibh maith agat as do spéis i rannchuidiú! Clúdaíonn an treoir seo gach rud a theastaíonn uait chun tosú.

Maidir leis an sreabhadh oibre oifigiúil do gach athrú, tosaigh leis an
[Bealach Órga Rannchuidithe](docs/ops/CONTRIBUTION_GOLDEN_PATH.md). Mapálann sé athruithe ar sholáthraithe, ródú,
UI/UX, i18n, CLI, bunachair sonraí, agus tógáil/imscaradh chuig a gconarthaí, tástálacha spriocdhírithe, clúdach CI,
agus céimeanna réitigh.

---

## Socrú Forbartha

### Réamhriachtanais

- **Node.js** `>=22.22.2 <23`, nó `>=24.0.0 <27` (molta: 24 LTS)
- **npm** 10+

> **Windows le Node 24:** bain úsáid as an leagan paiste reatha de 24 LTS (24.20.0 ar a laghad).
> Is féidir le leaganacha níos luaithe scor tar éis tástálacha rathúla nuair a dhúnann `--test-force-exit` an
> próiseas. Réitíonn [socrú Windows libuv de chuid Node](https://github.com/nodejs/node/pull/61999) an
> timpiste rite seo; coinnigh na dearbhuithe tástála agus na seiceálacha scoir den rithitheoir cumasaithe.

> **Úsáideoirí npm v11+ (Node 24+):** Tar éis `npm install`, fíoraigh gur suiteáladh na modúil dhúchasacha:
> `node -e "require('better-sqlite3')"`. Má theipeann air le `MODULE_NOT_FOUND`,
> rith `npm approve-scripts better-sqlite3 && npm install`. Féach ar
> [Fabhtcheartú](docs/guides/TROUBLESHOOTING.md#npm-v11-better-sqlite3-not-installed-cannot-find-module).

- **Git**

### Clónáil agus Suiteáil

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

### Athróga Timpeallachta

```bash
# Cruthaigh do .env ón teimpléad
cp .env.example .env

# Gin na rúin riachtanacha
echo "JWT_SECRET=$(openssl rand -base64 48)" >> .env
echo "API_KEY_SECRET=$(openssl rand -hex 32)" >> .env
```

Príomhathróga don fhorbairt:

| Athróg                 | Réamhshocrú Forbartha    | Cur Síos                             |
| ---------------------- | ------------------------ | ------------------------------------ |
| `PORT`                 | `20128`                  | Port an fhreastalaí                  |
| `NEXT_PUBLIC_BASE_URL` | `http://localhost:20128` | BuntURL don chomhéadan tosaigh       |
| `JWT_SECRET`           | (gin thuas)              | Rún sínithe JWT                      |
| `INITIAL_PASSWORD`     | `CHANGEME`               | Focal faire don chéad logáil isteach |
| `APP_LOG_LEVEL`        | `info`                   | Leibhéal mionsonraithe na logála     |

### Socruithe an Phainéil

Soláthraíonn an painéal scoránna Chomhéadain le haghaidh gnéithe ar féidir iad a chumrú trí athróga timpeallachta freisin:

| Suíomh an tSocraithe | Scorán                          | Cur Síos                                             |
| -------------------- | ------------------------------- | ---------------------------------------------------- |
| Settings → Advanced  | Mód Dífhabhtaithe               | Cumasaigh logaí iarratas dífhabhtaithe (Chomhéadain) |
| Settings → General   | Infheictheacht an Bharra Taoibh | Taispeáin/folaigh rannóga an bharra taoibh           |

Stóráiltear na socruithe seo sa bhunachar sonraí agus maireann siad thar atosuithe, rud a sháraíonn réamhshocruithe na n-athróg timpeallachta nuair a shocraítear iad.

### Rith go hÁitiúil

```bash
# Mód forbartha (athlódáil te)
npm run dev

# Tógáil táirgeachta
npm run build    # next build → .build/next/ agus ansin assembleStandalone → dist/
npm run start

# Tiomsú tapa backend/API amháin le haghaidh athruithe rannpháirtithe
npm run build:contributor

# Tógáil eisiúna (atógáil ghlan + comhartha HEAD — riachtanach don imscaradh)
npm run build:release   # rm -rf .build dist agus build + scríobhann sé dist/BUILD_SHA

# Cumraíocht choitianta poirt
PORT=20128 NEXT_PUBLIC_BASE_URL=http://localhost:20128 npm run dev
```

Déanann tógáil an rannpháirtí bailíochtú tiomsaithe amháin: ní chóimeálann sí an dáileadh neamhspleách ná ní thógann sí sócmhainní roghnacha pacáistithe dúchasacha. Bain úsáid as an ngnáththógáil táirgeachta nuair is gá duit an beart is féidir a sheoladh a bhailíochtú.

### Leagan Amach Aschur na Tógála

| Comhadlann | Ábhar                                                                                   | Rianaithe |
| ---------- | --------------------------------------------------------------------------------------- | --------- |
| `src/`     | Foinse an fheidhmchláir (TypeScript / TSX)                                              | Tá        |
| `.build/`  | Idirmheánacha — aschur `next build` (neamhshuimithe ag git, `distDir = .build/next`)    | Níl       |
| `dist/`    | Beart is féidir a sheoladh — cóimeáilte ag `assembleStandalone` (neamhshuimithe ag git) | Níl       |

Is pas aonair é píblíne na tógála:

```
npm run build
  └─ next build → .build/next/standalone  (aschur Next.js)
  └─ assembleStandalone()                 (cóipeálann standalone + static + public + native assets)
       └─ output: dist/                   (server.js, .next/static/, public/, node_modules/)
```

Glanann `npm run build:release` an dá chomhadlann ar dtús freisin agus scríobhann sé
`dist/BUILD_SHA` (= `git rev-parse --short HEAD`) mar chomhartha sláine imscartha.

Úsáideann `npm run build:contributor` próifíl tógála backend amháin. Cuireann sé comhaid Chomhéadain an phainéil ina n-ionad go sealadach agus é á thógáil, coinníonn sé láimhseálaithe ródanna API, agus cuireann sé na comhaid bhunaidh ar ais tar éis na tógála. Bain úsáid as `npm run build` le haghaidh athruithe a théann i bhfeidhm ar Chomhéadain an phainéil nó le haghaidh bailíochtú iomlán eisiúna; ní ionadach don tógáil eisiúna é próifíl an rannpháirtí.

> **Nóta maidir le himscaradh VPS:** níl aon athrú ar chomhadlann na híomhá cianda `/usr/lib/node_modules/omniroute/app/`.
> Déanann na scileanna imscartha inneachar `dist/` a rsync inti.
> Níor athraíodh ach cosán aschuir na tógála sa stór (`app/` → `dist/`).

URLanna réamhshocraithe:

- **Painéal**: `http://localhost:20128/dashboard`
- **API**: `http://localhost:20128/v1`

---

## Sreabhadh Oibre Git

> ⚠️ **NÁ déan tiomnú go díreach chuig `main` RIAMH.** Úsáid brainsí gné i gcónaí.
>
> **Bonn PR:** dírigh ar an mbrainse gníomhach `release/vX.Y.Z` (ní `main`). Féach
> [`docs/ops/BRANCHING_MODEL.md`](docs/ops/BRANCHING_MODEL.md) don tsamhail
> eisiúint-in-aghaidh-an-bhrainse + clib-ar-eisiúint.

```bash
# Cruthaigh brainse ó bharr na heisiúna gníomhaí (sampla: release/v3.8.49)
git fetch origin
git checkout -b feat/your-feature-name origin/release/v3.8.49
# ... déan athruithe ...
git commit -m "feat: describe your change"
git push -u origin feat/your-feature-name
# Oscail Pull Request le base = release/v3.8.49
```

### Ainmniú Brainse

| Réimír      | Cuspóir                          |
| ----------- | -------------------------------- |
| `feat/`     | Gnéithe nua                      |
| `fix/`      | Ceartúcháin fabhtanna            |
| `refactor/` | Athstruchtúrú cóid               |
| `docs/`     | Athruithe doiciméadachta         |
| `test/`     | Tástálacha a chur leis/a dheisiú |
| `chore/`    | Uirlisí, CI, spleáchais          |

### Teachtaireachtaí Tiomnúcháin

Lean [Conventional Commits](https://www.conventionalcommits.org/):

```
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
```

Scóip (v3.8): `db`, `sse`, `oauth`, `dashboard`, `api`, `cli`, `docker`, `ci`, `mcp`, `a2a`, `memory`, `skills`, `cloud-agent`, `guardrails`, `compression`, `auto-combo`, `resilience`, `providers`, `executors`, `translator`, `domain`, `authz`.

---

## Tástálacha a Rith

```bash
# Gach tástáil (aonaid + vitest + éiceachóras + e2e)
npm run test:all

# Comhad tástála aonair (reathaí tástála dúchasach Node.js — úsáideann formhór na dtástálacha é seo)
node --import tsx/esm --test tests/unit/your-file.test.ts

# Na tástálacha aonaid amháin a bhfuil tionchar ag d’athrú orthu (an roghnóir TIA céanna le geata CI, #8084)
npm run test:scoped            # athruithe sa tiomantas is déanaí (nó sa chrann oibre)
npm run test:scoped:staged     # athruithe céimnithe amháin — oibríonn go maith le rith réamhthiomantais
npm run test:scoped:full       # atóg an léarscáil ghraif iompórtála ar dtús (tar éis comhaid a chur leis/a bhogadh)
# Ciallaíonn scor 1 + "rith an tsraith iomlán" gur athraíodh comhad moil (tsconfig, package.json, …) nó foinse
# neamh-mhapáilte — teipeann an roghnóir go sábháilte, ní scipeálann sé aon rud go ciúin riamh.

# Vitest (freastalaí MCP, autoCombo, taisce)
npm run test:vitest

# Tástálacha E2E (Playwright de dhíth)
npm run test:e2e

# E2E do chliaint phrótacail (iompar MCP, A2A)
npm run test:protocols:e2e

# Tástálacha comhoiriúnachta éiceachórais
npm run test:ecosystem

# Geata cumhdaigh: 60% de ráitis/línte/feidhmeanna/brainsí
npm run test:coverage
npm run coverage:report

# Seiceáil lint + formáidithe
npm run lint
npm run check

# Tástáil thobdheataigh teaglama le fíorfhoinsí réamhtheachtacha faoi gheata (rochtain VPS + creidmheasanna fíorsholáthraí de dhíth)
# Déanann sé teagmháil le FÍORSHOLÁTHRAITHE — cosnaíonn sé beagán. Ní ritheann sé i CI RIAMH. Scipeálann sé go glan gan an geata.
# De dhíth: rochtain ssh root@192.168.0.15 (faightear seat DB inléite amháin ón VPS).
RUN_COMBO_LIVE=1 npm run test:combo:live

# Tástáil thobdheataigh bheo VPS chéim 3 — scripteanna simplí Node ESM, a dhéanann teagmháil dhíreach le freastalaí beo .15.
# De dhíth: rochtain ssh root@192.168.0.15 (cruthaítear/díchóimeáiltear teaglamaí trí SSH sqlite).
# Déanann sé teagmháil le FÍORSHOLÁTHRAITHE (costas beag). Ní chruthaíonn/scriosann sé ach teaglamaí __live_test__*. Ní ritheann sé i CI RIAMH.
# Tá REQUIRE_API_KEY=false ar .15 agus mar sin níl eochair API de dhíth, ach urramaíonn sé COMBO_LIVE_BASE_URL / COMBO_LIVE_API_KEY má tá siad socraithe.
npm run test:combo:live:vps              # 7 gcás HTTP (tosaíocht/babhta-i-ndiaidh-babhta/ualaithe/costas/comhleá/uathoibríoch + sláinte)
npm run test:combo:live:vps:failover     # cuireann sé cás fíor-theipaistrithe tras-soláthraí leis (8 san iomlán)
```

Nótaí cumhdaigh:

- Tomhaiseann `npm run test:coverage` cumhdach foinseach don phríomhshraith tástálacha aonaid, fágann sé `tests/**` as an áireamh, agus cuireann sé `open-sse/**` san áireamh
- Ní mór d’iarratais tarraingthe an geata cumhdaigh a choinneáil ag **60%+** de ráitis/línte/feidhmeanna/brainsí
- Má athraíonn PR cód táirgthe in `src/`, `open-sse/`, `electron/`, nó `bin/`, ní mór dó tástálacha uathoibrithe a chur leis nó a nuashonrú sa PR céanna
- Priontálann `npm run coverage:report` an tuairisc mhionsonraithe de réir comhaid ón rith cumhdaigh is déanaí
- Caomhnaíonn `npm run test:coverage:legacy` an mhéadracht níos sine le haghaidh comparáid stairiúil
- Féach `docs/ops/COVERAGE_PLAN.md` don treochlár céimnithe um fheabhsú cumhdaigh

### Ceanglais maidir le hIarratas Tarraingthe

Sula n-osclaíonn tú PR, úsáid
[Bealach Órga na Rannpháirtíochta](docs/ops/CONTRIBUTION_GOLDEN_PATH.md) chun an lúb spriocdhírithe a rith le haghaidh
an mhéid a d’athraigh tú. Is faoi CI atá an tsraith iomlán tástálacha aonaid (4 sharda CI), Vitest, an geata cumhdaigh **60%+**, agus
an tógáil táirgthe — ní sholáthraíonn a rith go háitiúil aon fhaisnéis nach dtabharfaidh na seiceálacha PR duit cheana féin, agus ar ríomhairí níos lú féadfaidh sé an t-óstach a sháithiú (#8084):

- Rith na comhaid tástála a chumhdaíonn d’athrú: `node --import tsx/esm --test tests/unit/<file>.test.ts`
- Rith `npm run lint`
- Cuir tástálacha uathoibrithe san áireamh nó nuashonraigh iad sa PR céanna aon uair a athraítear cód táirgthe
- I gcomhaid `node:test`, cuir gach `await` barrleibhéil (amhail `await import(...)`) roimh an gcéad `test()` / `describe()`: faoi `--test-force-exit`, d’fhéadfadh sé nach rithfí go ciúin riamh tástálacha a chláraítear ina dhiaidh (#18045; forfheidhmítear é le `npm run check:test-tla-order`)
- Cuir na comhaid tástála a athraíodh nó a cuireadh leis i dtuairisc an PR nuair a athraíodh cód táirgthe
- Seiceáil toradh SonarQube ar an PR nuair atá rúin an tionscadail cumraithe in CI

Stádas reatha na dtástálacha: **122 comhad tástála aonaid** a chumhdaíonn:

- Aistritheoirí soláthraithe agus tiontú formáide
- Teorannú ráta, scoradán ciorcaid, agus athléimneacht
- Taisce shéimeantach, iolrachas sábháilte, rianú dul chun cinn
- Oibríochtaí bunachair sonraí agus scéimre (21 modúl DB)
- Sreafaí OAuth agus fíordheimhniú
- Bailíochtú críochphointí API (Zod v4)
- Uirlisí freastalaí MCP agus forfheidhmiú scóipe
- Córais Cuimhne agus Scileanna

---

## Stíl an Chóid

- **ESLint** — Rith `npm run lint` sula ndéanann tú commit
- **Prettier** — Formáidítear go huathoibríoch trí `lint-staged` tráth commit (2 spás, leathstadanna, comharthaí athfhriotail dúbailte, leithead 100 carachtar, camóga deiridh es5)
- **TypeScript** — Úsáideann gach cód in `src/` `.ts`/`.tsx`; úsáideann `open-sse/` `.ts`/`.js`; déan doiciméadú le TSDoc (`@param`, `@returns`, `@throws`)
- **Gan `eval()`** — Cuireann ESLint `no-eval`, `no-implied-eval`, `no-new-func` i bhfeidhm
- **Bailíochtú Zod** — Úsáid scéimeanna Zod v4 chun gach ionchur API a bhailíochtú
- **Ainmniú**: Comhaid = camelCase/kebab-case, comhpháirteanna = PascalCase, tairisigh = UPPER_SNAKE

### Láimhseáil earráidí / blocanna catch folmha

Ná fág `catch` gan mhíniú riamh. Rangaigh i gceann amháin de dhá chatagóir é (cuireann sé seo
an riail dhocht "ná slog earráidí go ciúin riamh i sruthanna SSE" i bhfeidhm go praiticiúil):

- **D'aon ghnó (ár nglanadh/teiliméadracht féin ar bhonn na hiarrachta is fearr)** — táthar ag súil le teip anseo agus
  tá sí neamhdhíobhálach; cuir nóta tráchta aonlíne leis a mhíníonn an chúis, gan logáil (is í an logáil ar gach iarratas
  an torann a sheachnaíonn an coinbhinsiún seo).

  ```ts
  } catch {} // táthar ag súil le rialaitheoir atá dúnta cheana a dhúnadh tar éis don chliant dícheangal
  ```

- **Ba cheart logáil (cód seachtrach/cód arna sholáthar ag an nglaoiteoir, nó má athraíonn an slogadh sreabhadh an rialaithe)** — coinnigh
  an catch (ná lig dó an sruth a bhriseadh riamh) ach astaigh `console.debug`/`warn` comhthéacsúil ionas gur féidir
  an teip a aimsiú.

  ```ts
  } catch (e) {
    console.debug("[STREAM] onFailure callback error:", e);
  }
  ```

Féach `open-sse/utils/stream.ts` agus `open-sse/utils/streamHandler.ts` le haghaidh samplaí curtha i bhfeidhm.

---

## Struchtúr an Tionscadail

```
src/                        # TypeScript (.ts / .tsx)
├── app/                    # App Router Next.js 16
│   ├── (dashboard)/        # Leathanaigh an deais (23 rannán)
│   ├── api/                # Bealaí API (51 chomhadlann)
│   └── login/              # Leathanaigh fíordheimhnithe (.tsx)
├── domain/                 # Inneall beartais (policyEngine, comboResolver, costRules, etc.)
├── lib/                    # Croíloighic ghnó (.ts)
│   ├── a2a/                # Freastalaí prótacail Agent-to-Agent v0.3
│   ├── acp/                # Clárlann Agent Communication Protocol
│   ├── compliance/         # Inneall beartais comhlíontachta
│   ├── db/                 # Modúil fearainn SQLite + 130 aistriú
│   ├── memory/             # Cuimhne chomhrá mharthanach
│   ├── oauth/              # Soláthraithe, seirbhísí agus fóntais OAuth
│   ├── skills/             # Creat scileanna insínte
│   ├── usage/              # Rianú úsáide agus ríomh costas
│   └── localDb.ts          # Ciseal ath-easpórtála amháin — ná cuir loighic anseo choíche
├── middleware/              # Meánearraí iarratais (promptInjectionGuard)
├── mitm/                   # Seachfhreastalaí MITM (teastas, DNS, ródú sprice)
├── shared/
│   ├── components/         # Comhpháirteanna React (.tsx)
│   ├── constants/          # Sainmhínithe soláthraithe (329), scóip MCP, 20 straitéis ródaithe
│   ├── utils/              # Scoradán ciorcaid, sláintitheoir, cúntóirí fíordheimhnithe
│   └── validation/         # Scéimeanna Zod v4
└── sse/                    # Píblíne seachfhreastalaí SSE

open-sse/                   # Spás oibre @omniroute/open-sse
├── executors/              # 150 modúl riteora (aicmí riteora + cúntóirí do gach soláthraí)
├── handlers/               # 11 láimhseálaí iarratais (comhrá, freagraí, leabuithe, íomhánna, etc.)
├── mcp-server/             # Freastalaí MCP (110 uirlis uathúil, 3 mheicníocht iompair, 33 scóip)
├── services/               # 178 seirbhís ardleibhéil (combo, autoCombo, rateLimitManager, etc.)
├── translator/             # Aistritheoirí formáide (OpenAI ↔ Claude ↔ Gemini ↔ Responses ↔ Ollama)
├── transformer/            # Claochladán API Responses
└── utils/                  # 22 modúl fóntais (sruthú, TLS, seachfhreastalaí, logáil)

electron/                   # Aip deisce Electron (trasardán)

tests/
├── unit/                   # Riteoir tástálacha Node.js (1,574 comhad tástála)
├── integration/            # Tástálacha comhtháthaithe
├── e2e/                    # Tástálacha Playwright
├── security/               # Tástálacha slándála
├── translator/             # Tástálacha a bhaineann go sonrach leis an aistritheoir
└── load/                   # Tástálacha ualaigh

docs/
├── adr/                     # Taifid Chinntí Ailtireachta
├── architecture/            # Ailtireacht agus athléimneacht an chórais
├── comparison/              # OmniRoute i gcomparáid le roghanna malartacha
├── compression/             # Treoracha agus rialacha comhbhrúite
├── dev/                     # Treoracha forbartha
├── diagrams/                # Léaráidí ailtireachta
├── frameworks/              # MCP, A2A, OpenCode, Cuimhne, Scileanna
├── guides/                  # Treoir úsáideora, Docker, cumraíocht, fabhtcheartú
├── i18n/                    # Aistriúcháin idirnáisiúnaithe README
├── marketing/               # Ábhair mhargaíochta
├── ops/                     # Imscaradh, seachfhreastalaí, cumhdach, eisiúintí
├── providers/               # Doiciméid a bhaineann go sonrach le soláthraithe
├── reference/               # Tagairt API, athróga timpeallachta, uirlisí CLI, sraitheanna saor in aisce
├── releases/                # Nótaí eisiúna
├── routing/                 # Inneall uath-theaglama, athsheinm réasúnaíochta
├── screenshots/             # Gabhálacha scáileáin den deais
├── security/                # Ráillí cosanta, comhlíontacht, ceilteacht, comharthaí
└── specs/                   # Sonraíochtaí dearaidh
```

---

## Soláthraí Nua a Chur Leis

### Céim 1: Tairisigh an tSoláthraí a Chlárú

Cuir le `src/shared/constants/providers.ts` — bailíochtaithe ag Zod nuair a lódáiltear an modúl.

### Céim 2: Seiceadóir a Chur Leis (má tá loighic shaincheaptha de dhíth)

Cruthaigh seiceadóir in `open-sse/executors/your-provider.ts` a leathnaíonn an bunseiceadóir.

### Céim 3: Aistritheoir a Chur Leis (má úsáidtear formáid nach formáid OpenAI í)

Cruthaigh aistritheoirí iarratais/freagartha in `open-sse/translator/`.

### Céim 4: Cumraíocht OAuth a Chur Leis (má tá sé bunaithe ar OAuth)

Cuir dintiúir OAuth in `src/lib/oauth/constants/oauth.ts` agus seirbhís in `src/lib/oauth/services/`.

Má dháileann an soláthraí réamhtheachtach `client_id`/rún poiblí OAuth nó eochair Firebase Web API laistigh dá CLI poiblí / bheart brabhsálaí, **ná** leabaigh mar theaghrán litriúil é. Úsáid `resolvePublicCred()` ó `open-sse/utils/publicCreds.ts` agus cuir iontráil bheart chumhdaithe le `EMBEDDED_DEFAULTS`. Tá an sreabhadh oibre éigeantach iomlán doiciméadaithe in [`docs/security/PUBLIC_CREDS.md`](./docs/security/PUBLIC_CREDS.md).

Laistigh de láimhseálaithe/seiceadóirí, ní mór do theachtaireachtaí earráide a shroicheann an cliant dul trí `buildErrorBody()` / `sanitizeErrorMessage()` ó `open-sse/utils/error.ts` — ná cuir `err.stack` ná `err.message` amh i gcorp Response choíche. Féach [`docs/security/ERROR_SANITIZATION.md`](./docs/security/ERROR_SANITIZATION.md).

### Céim 5: Samhlacha a Chlárú

Cuir sainmhínithe samhlacha in `open-sse/config/providerRegistry.ts`.

### Céim 6: Tástálacha a Chur Leis

Scríobh tástálacha aonaid in `tests/unit/` a chlúdaíonn, ar a laghad:

- Clárú an tsoláthraí
- Aistriú iarratais/freagartha
- Láimhseáil earráidí

---

## Seicliosta Iarratais Tarraingthe

- [ ] Éiríonn leis na tástálacha (`npm test`)
- [ ] Éiríonn leis an lintáil (`npm run lint`)
- [ ] Éiríonn leis an tiomsú (`npm run build`)
- [ ] Cineálacha TypeScript curtha leis le haghaidh feidhmeanna agus comhéadain phoiblí nua
- [ ] Gan aon rúin ná luachanna cúltaca crua-chódaithe
- [ ] Dintiúir phoiblí réamhtheachtacha leabaithe trí `resolvePublicCred()` (féach [`docs/security/PUBLIC_CREDS.md`](./docs/security/PUBLIC_CREDS.md)), agus ní mar litearáil riamh
- [ ] Freagraí earráide seolta trí `buildErrorBody()` / `sanitizeErrorMessage()` — gan aon rianta amhchruaiche i gcorp na bhfreagraí (féach [`docs/security/ERROR_SANITIZATION.md`](./docs/security/ERROR_SANITIZATION.md))
- [ ] Orduithe blaoisce (`exec` / `spawn`) a chuireann luachanna ama rite ar aghaidh trí `env`, ní trí idirshuíomh teaghrán
- [ ] Gach ionchur bailíochtaithe le scéimeanna Zod
- [ ] **Blúire** den loga athruithe curtha leis faoi `changelog.d/{features|fixes|maintenance}/<PR>-<slug>.md` le haghaidh athruithe atá infheicthe ag úsáideoirí (féach [`changelog.d/README.md`](./changelog.d/README.md)) — ná cuir `CHANGELOG.md` in eagar go díreach; déantar na blúirí a chomhiomlánú tráth an eisiúna agus ní bhíonn coinbhleacht eatarthu riamh i measc PRanna
- [ ] Doiciméadacht nuashonraithe (más infheidhme)
- [ ] Gan aon fholáirimh nua CodeQL / Secret-Scanning oscailte, nó gach ceann acu diúltaithe le bonn cirt teicniúil a thagraíonn don doiciméad ábhartha in `docs/security/`
- [ ] Bealaí a sceitheann próisis mhac (`/api/mcp/`, `/api/cli-tools/runtime/`) aicmithe mar `isLocalOnlyPath()` in `src/server/authz/routeGuard.ts` — féach [Riail Dhocht #15](docs/security/ROUTE_GUARD_TIERS.md)
- [ ] Gan aon leantóirí `Co-authored-by` ó IS/róbónna i dteachtaireachtaí tiomantais (Riail Dhocht #16) — tugtar aitheantas do chomhoibrithe daonna a n-athúsáidtear a gcuid oibre le leantóirí caighdeánacha `Co-authored-by: Name <email>`

---

## Eisiúintí

Déantar eisiúintí a bhainistiú tríd an sreabhadh oibre `/generate-release`. Nuair a chruthaítear Eisiúint nua GitHub, foilsítear an pacáiste **go huathoibríoch ar npm** trí GitHub Actions.

Le haghaidh imlonnuithe VPS, úsáid `npm run build:release` (seachas `npm run build`) — déanann sé atógáil ghlan,
cuireann sé an beart le chéile in `dist/`, agus scríobhann sé an marcóir `dist/BUILD_SHA`.
Ansin úsáid na scileanna `/deploy-vps-*-cc`, a dhéanann `dist/` a rsyncáil chuig an gcomhadlann chianda `app/`.

---

## Cabhair a Fháil

- **Ailtireacht**: Féach [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md)
- **Tagairt API**: Féach [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md)
- **Doiciméid slándála**: [`docs/security/CLI_TOKEN.md`](docs/security/CLI_TOKEN.md), [`docs/security/ROUTE_GUARD_TIERS.md`](docs/security/ROUTE_GUARD_TIERS.md), [`docs/security/ERROR_SANITIZATION.md`](docs/security/ERROR_SANITIZATION.md), [`docs/security/PUBLIC_CREDS.md`](docs/security/PUBLIC_CREDS.md)
- **Doiciméid oibríochtaí**: [`docs/ops/SQLITE_RUNTIME.md`](docs/ops/SQLITE_RUNTIME.md)
- **Fadhbanna**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues)