项目文件夹

文件
wehub-resource-sync d48cda4081
CI / Test (ubuntu-latest, Node 18.x, bun) (push) Failing after 15m1s
CI / Test (ubuntu-latest, Node 18.x, npm) (push) Failing after 15m1s
CI / Test (ubuntu-latest, Node 18.x, pnpm) (push) Failing after 15m1s
CI / Test (ubuntu-latest, Node 18.x, yarn) (push) Failing after 15m1s
CI / Test (ubuntu-latest, Node 20.x, bun) (push) Failing after 17m13s
CI / Test (ubuntu-latest, Node 20.x, npm) (push) Failing after 18m42s
CI / Test (ubuntu-latest, Node 20.x, pnpm) (push) Failing after 15m0s
CI / Test (ubuntu-latest, Node 20.x, yarn) (push) Failing after 49m44s
CI / Test (ubuntu-latest, Node 22.x, bun) (push) Failing after 51m55s
CI / Test (ubuntu-latest, Node 22.x, pnpm) (push) Failing after 21m57s
CI / Test (ubuntu-latest, Node 22.x, npm) (push) Failing after 37m39s
CI / Test (ubuntu-latest, Node 22.x, yarn) (push) Failing after 34m7s
CI / Validate Components (push) Failing after 37m15s
CI / Python Tests (push) Failing after 10m1s
CI / Security Scan (push) Failing after 10m1s
CI / Lint (push) Failing after 17m12s
CI / Coverage (push) Failing after 20m19s
CI / Test (macos-latest, Node 18.x, bun) (push) Has been cancelled
CI / Test (macos-latest, Node 18.x, npm) (push) Has been cancelled
CI / Test (macos-latest, Node 18.x, pnpm) (push) Has been cancelled
CI / Test (macos-latest, Node 18.x, yarn) (push) Has been cancelled
CI / Test (windows-latest, Node 18.x, npm) (push) Has been cancelled
CI / Test (windows-latest, Node 18.x, pnpm) (push) Has been cancelled
CI / Test (windows-latest, Node 18.x, yarn) (push) Has been cancelled
CI / Test (macos-latest, Node 20.x, bun) (push) Has been cancelled
CI / Test (macos-latest, Node 20.x, npm) (push) Has been cancelled
CI / Test (macos-latest, Node 20.x, pnpm) (push) Has been cancelled
CI / Test (macos-latest, Node 20.x, yarn) (push) Has been cancelled
CI / Test (windows-latest, Node 20.x, npm) (push) Has been cancelled
CI / Test (windows-latest, Node 20.x, pnpm) (push) Has been cancelled
CI / Test (windows-latest, Node 20.x, yarn) (push) Has been cancelled
CI / Test (macos-latest, Node 22.x, bun) (push) Has been cancelled
CI / Test (macos-latest, Node 22.x, npm) (push) Has been cancelled
CI / Test (macos-latest, Node 22.x, pnpm) (push) Has been cancelled
CI / Test (macos-latest, Node 22.x, yarn) (push) Has been cancelled
CI / Test (windows-latest, Node 22.x, npm) (push) Has been cancelled
CI / Test (windows-latest, Node 22.x, pnpm) (push) Has been cancelled
CI / Test (windows-latest, Node 22.x, yarn) (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 11:55:55 +08:00

85 行
3.2 KiB
Markdown

此文件含有模棱两可的 Unicode 字符
此文件含有可能会与其他字符混淆的 Unicode 字符。 如果您是想特意这样的,可以安全地忽略该警告。 使用 Escape 按钮显示他们。
# Update Documentation
Dokümanları codebase ile senkronize et, truth-of-source dosyalarından oluştur.
## Adım 1: Truth Kaynaklarını Tanımla
| Kaynak | Oluşturur |
|--------|-----------|
| `package.json` scripts | Mevcut komutlar referansı |
| `.env.example` | Environment variable dokümanı |
| `openapi.yaml` / route dosyaları | API endpoint referansı |
| Kaynak kod export'ları | Public API dokümanı |
| `Dockerfile` / `docker-compose.yml` | Altyapı kurulum dokümanları |
## Adım 2: Script Referansı Oluştur
1. `package.json`'ı oku (veya `Makefile`, `Cargo.toml`, `pyproject.toml`)
2. Tüm script'leri/komutları açıklamalarıyla birlikte çıkar
3. Bir referans tablosu oluştur:
```markdown
| Command | Description |
|---------|-------------|
| `npm run dev` | Hot reload ile development server'ı başlat |
| `npm run build` | Type checking ile production build |
| `npm test` | Coverage ile test suite'ini çalıştır |
```
## Adım 3: Environment Dokümanı Oluştur
1. `.env.example`'ı oku (veya `.env.template`, `.env.sample`)
2. Tüm değişkenleri amaçlarıyla birlikte çıkar
3. Zorunlu vs isteğe bağlı olarak kategorize et
4. Beklenen format ve geçerli değerleri dokümante et
```markdown
| Variable | Required | Description | Example |
|----------|----------|-------------|---------|
| `DATABASE_URL` | Yes | PostgreSQL bağlantı string'i | `postgres://user:pass@host:5432/db` |
| `LOG_LEVEL` | No | Log detay seviyesi (varsayılan: info) | `debug`, `info`, `warn`, `error` |
```
## Adım 4: Contributing Guide'ı Güncelle
`docs/CONTRIBUTING.md`'yi şunlarla oluştur veya güncelle:
- Development environment kurulumu (ön koşullar, kurulum adımları)
- Mevcut script'ler ve amaçları
- Test prosedürleri (nasıl çalıştırılır, nasıl yeni test yazılır)
- Kod stili zorlama (linter, formatter, pre-commit hook'ları)
- PR gönderim kontrol listesi
## Adım 5: Runbook'u Güncelle
`docs/RUNBOOK.md`'yi şunlarla oluştur veya güncelle:
- Deployment prosedürleri (adım adım)
- Health check endpoint'leri ve izleme
- Yaygın sorunlar ve düzeltmeleri
- Rollback prosedürleri
- Uyarı ve eskalasyon yolları
## Adım 6: Güncellik Kontrolü
1. 90+ gün değiştirilmemiş doküman dosyalarını bul
2. Son kaynak kod değişiklikleriyle çapraz referans yap
3. Manuel gözden geçirme için potansiyel güncel olmayan dokümanları işaretle
## Adım 7: Özeti Göster
```
Documentation Update
──────────────────────────────
Updated: docs/CONTRIBUTING.md (scripts table)
Updated: docs/ENV.md (3 new variables)
Flagged: docs/DEPLOY.md (142 days stale)
Skipped: docs/API.md (no changes detected)
──────────────────────────────
```
## Kurallar
- **Tek truth kaynağı**: Her zaman koddan oluştur, oluşturulan bölümleri asla manuel düzenleme
- **Manuel bölümleri koru**: Sadece oluşturulan bölümleri güncelle; elle yazılmış prose'u bozulmamış bırak
- **Oluşturulan içeriği işaretle**: Oluşturulan bölümlerin etrafında `<!-- AUTO-GENERATED -->` marker'ları kullan
- **İstenmeyen doküman oluşturma**: Sadece komut açıkça talep ederse yeni doküman dosyaları oluştur