Bedrud Belgeler

Bedrud projesine katkılarınız memnuniyetle karşılanır. Bu rehber, değişikliklerin nasıl gönderileceğini açıklar.

Not: Resmi katkıda bulunma rehberi depo kök dizinindedir: CONTRIBUTING.md. Bu sayfa yalnızca referans amacıyla arşivlenmiştir.

Başlangıç

  1. Depoyu fork edin
  2. Fork’unuzu klonlayın
  3. main dalından bir özellik dalı oluşturun
  4. Değişikliklerinizi yapın
  5. Bir pull request gönderin

Ön Koşullar

  • Go 1.22+
  • Bun (web ön ucu için)
  • Rust (masaüstü uygulaması için)
  • Make
  • Git

Geliştirme Kurulumu

# GitHub'da forkladıktan sonra fork'unuzu klonlayın
git clone https://github.com/<your-username>/bedrud.git
cd bedrud
make init
make dev

Ayrıntılı kurulum talimatları için Geliştirme İş Akışı sayfasına bakın.

Proje Yapısı

DizinDilAçıklama
server/GoArka uç API ve gömülü LiveKit
apps/web/TypeScript/ReactWeb ön ucu
apps/desktop/Rust + SlintMasaüstü uygulaması
apps/android/KotlinAndroid uygulaması
apps/ios/SwiftiOS uygulaması
agents/PythonBot aracıları
packages/TypeScriptPaylaşılan tür tanımları
tools/cli/PythonDağıtım CLI’si
docs/MarkdownBelgelendirme

Kod Stili

DilStandart
Gogofmt
TypeScript/ReactBiome
KotlinAndroid Studio varsayılanları
SwiftXcode varsayılanları
Pythonruff

Pull Request Süreci

  1. Dal adlandırması: feature/description, fix/description veya docs/description
  2. Commit mesajları: <eylem> <neyi> <neden> (ör., add user model for auth feature, fix login redirect for expired sessions)
  3. CI kontrolleri: Tüm GitHub Actions kontrolleri geçmelidir
  4. Açıklama: Nelerin değiştiğini ve nedenini belirtin

CI Kontrolleri

Her PR’da şu kontroller otomatik olarak çalışır:

KontrolDoğruladığı şey
Servergo vet, derleme, testler
WebTypeScript tip kontrolü, derleme
AndroidLint, birim testleri
iOSDerleme, test (simülatör)

Sorun Bildirme

GitHub Issues üzerinden şu bilgilerle sorun bildirebilirsiniz:

  • Hatayı yeniden oluşturma adımları
  • Beklenen ve gerçekleşen davranış
  • Ortam bilgileri (işletim sistemi, tarayıcı, uygulama sürümü)

Belgelendirme

Belgeler docs/ dizininde yer alır ve MkDocs Material ile oluşturulur.

Yerel Önizleme

pip install mkdocs-material
mkdocs serve

Ardından tarayıcınızda http://localhost:8000 adresini açın.

Yapı

Belge sayfaları konuya göre düzenlenmiştir. Navigasyon, proje kök dizinindeki mkdocs.yml dosyasında tanımlanır.

Lisans

Katkıda bulunarak, katkılarınızın Apache License 2.0 kapsamında lisanslanmasını kabul etmiş olursunuz.