Fejlesztői útmutató
Munkapéldány
Klónozza a tárolót, olvassa az AGENTS.md fájlt. Plugin CI: Linux/Windows Node 20; webhely: Node 24. Gyökér és website/ külön függőségtelepítést használ.
npm ci
npx --no-install playwright install --with-deps chromium
node node_modules/playwright-chromium/cli.js install chromium
npm run build
npm test -- --runInBand
A két Playwright-csomag eltérő Chromium-revíziót kérhet; egy telepítés nem elég. A main.js generált és Git által figyelmen kívül hagyott fájl. Régi helyi bundle nem igazolja az új commitot.
Felelősségi határok
| Felelősség | Elsődleges forrás |
|---|---|
| Életciklus, parancsok és hostkapcsolat | src/main.ts |
| Szolgáltatói profilok, protokollmetaadat és validáció | src/llmProviders.ts |
| Kérések, transportok, ismétlések és streamek | src/llmUtils.ts |
| Műveletek, sémák és nyilvános CLI-részhalmaz | src/operations/, src/cliContracts.ts |
| Fájlműveletek, kutatás és fordítás | src/fileUtils.ts, src/searchUtils.ts, src/translate.ts |
| Folyamatműveletek és oldalsáv | src/workflowButtons.ts, src/ui/NotemdSidebarView.ts |
| Diagramspecifikációk és renderelés | src/diagram/, src/rendering/ |
| UI-szövegek és nyelvek | src/i18n/ |
| Nyilvános útmutatók és fordítások | website/docs/, website/i18n/ |
| Karbantartási szabályok és dátumozott bizonyíték | docs/maintainer/ |
A produkciós bundle önálló, beágyazott előnézeti hosttal. Lehetséges külön hostútvonal nem a szállított csomag szerződése. Aktiválásához csomagolás, assets, ellenőrzések és dokumentumok összehangolása kell.
Körülhatárolt változtatás
- Reprodukáljon, és előbb írjon célzott, hibára futó tesztet.
- Az invariáns gazdájánál módosítson; a külső határon validáljon.
- Futtasson célzott és teljes teszteket, megőrizve megszakítást, hibaterjedést és tartós írást.
- Frissítse az angol forrást és érintett nyelveket. Terv, feladat és walkthrough teljes, külön angol/kínai párt igényel a
docs/alatt. - Vizuális/natív változást a valódi alkalmazásban teszteljen; XML, kép vagy build nem bizonyít szerkeszthetőséget és csatlakozó kötéseket.
Szolgáltatót a llmProviders.ts fájlban adjon hozzá, kompatibilis transportot használjon, fedje le a llmProviders.test.ts, llmUtilsProviderSupport.test.ts, README és kapcsolatteszteket. Tartsa meg a streaminget és megszakadt válaszokat. Művelet kitételéhez bemeneti/eredményséma, kontextus, mellékhatás és kezelési címke kell. Regisztráció nem nyilvános Agent-végpont. Agent.
Ellenőrzés
npm run build
npm test -- --runInBand
npm run audit:i18n-ui
npm run audit:render-host
npm run lint:regressions -- --base-ref origin/main
git diff --check
A lint egyedi diagnózisokat hasonlít; kisebb összlétszám nem igazol új regressziót. Visszakeresési változásnál futtassa az npm run benchmark:local-kb parancsot, és rögzítse a korpuszt/környezetet. Webhelyhez Node 24:
npm --prefix website ci
npm --prefix website run build
npm --prefix website run audit:build
npm run docs:build
Az 1.9.9 programban a fordításokat közvetlenül a Codex írja és ellenőrzi. Ne futtasson régi fordítószkriptet, LM Studiót vagy fordítási szolgáltatást. Formázás, validáció és a kész szöveg renderelése megengedett.
Obsidian és célalkalmazások
Használjon .notemd-host-verification jelölésű ideiglenes vaultot; a szkriptek a bemásolt bundle azonosságát vizsgálják. A felhasználói vault maradjon külön. Próbálja az obsidian help és obsidian-cli help parancsot is; hiányzó eszköz nem sikeres hostteszt.
PowerPoint, CircuitikZ és diaexport saját előfeltételekkel/artefaktumokkal rendelkezik. Kövesse a dátumozott elfogadási jegyzőkönyvet és kiadási folyamatot. Jelezze a fizikai mobilok és minimumverzió igazolatlan állapotát.
Közreműködés és kiadás
A PR írja le a problémát, végső viselkedést, teszteket és határokat. Reprodukció: Issues. Kulcsot, magánjegyzetet és idegen fájlt ne commitoljon. Egy publisher kezeli a verziókat, numerikus taget, tiszta tagforrást, kétnyelvű jegyzeteket, ellenőrzött draft fájlokat, publikálást és explicit Pages deployt. Nyilvános taget ne módosítson. A .trellis/ helyi munkafolyamat-állapot, nem CI-függőség.