Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
139 lines (94 loc) · 4.52 KB

CONTRIBUTING.md

File metadata and controls

139 lines (94 loc) · 4.52 KB
Raw

Katkida Bulunma Rehberi (Contributing Guide)

Bu belge, Space MBSE AI Repository projesine nasil katkida bulunabileceginizi aciklamaktadir.

Nasil Katkida Bulunulur (How to Contribute)

1. Depoyu Catallama (Fork)

  1. Bu depoyu kendi GitHub hesabiniza catallayin (fork).
  2. Catallanmis depoyu yerel makinenize klonlayin:
git clone https://github.com/<kullanici-adiniz>/space-mbse-ai-repository.git
cd space-mbse-ai-repository

2. Dal Olusturma (Branch)

Calismaniz icin yeni bir dal (branch) olusturun. Dal isimlendirme kurallarina uyun (asagiya bakiniz):

git checkout -b feature/yeni-ozellik-adi

3. Degisiklikleri Yapma

  • Kodunuzu yazin ve test edin.
  • Commit mesaji formatina uygun sekilde commit atin.
  • Degisikliklerinizi catallanmis deponuza gonderin (push):
git push origin feature/yeni-ozellik-adi

4. Cekme Istegi Acma (Pull Request)

  • GitHub uzerinden ana depoya bir Cekme Istegi (Pull Request / PR) acin.
  • PR aciklamasinda yaptiginiz degisiklikleri net bir sekilde belirtin.
  • Ilgili Issue numarasini referans gosterin (varsa).

Kodlama Standartlari (Coding Standards)

  • Dokumantasyon dili: Turkce
  • Teknik terimler: Ingilizce teknik terimler parantez icinde kullanilir. Ornek: "dal (branch)", "catallamak (fork)"
  • Python kodu: PEP 8 standartlarina uyulmalidir.
  • Yorum satirlari: Turkce aciklama + Ingilizce teknik terim seklinde yazilmalidir.
  • Dosya kodlamasi: UTF-8

Commit Mesaji Formati (Commit Message Format)

Tum commit mesajlari asagidaki formata uygun olmalidir:

<tip>(<kapsam>): <aciklama>

Tipler (Types)

Tip Aciklama
feat Yeni ozellik ekleme (new feature)
fix Hata duzeltme (bug fix)
docs Dokumantasyon degisikligi (documentation)
chore Bakim ve genel isler (maintenance)

Ornekler

feat(model): DellSat-77 termal alt sistemi eklendi
fix(script): XMI dogrulama hatasinin duzeltilmesi
docs(rehber): katki rehberi guncellendi
chore(bagimlilik): lxml surumu guncellendi

Kapsam Ornekleri (Scope Examples)

  • model - SysML model dosyalari
  • script - Python betikleri (scripts)
  • docs - Dokumantasyon
  • rehber - Rehber ve kilavuzlar
  • bagimlilik - Bagimliliklar (dependencies)
  • ci - Surekli entegrasyon (continuous integration)

Dal Isimlendirme (Branch Naming)

Dallar asagidaki kurallara gore isimlendirilmelidir:

Onek Kullanim Alani Ornek
feature/* Yeni ozellik gelistirme feature/termal-analiz-modeli
fix/* Hata duzeltme fix/xmi-dogrulama-hatasi

Kurallar

  • Dal isimleri kucuk harf ve tire (-) ile yazilmalidir.
  • Turkce karakterler kullanilmamalidir (a, c, g, i, o, s, u yerine ASCII karsiliklari).
  • Kisaca ve aciklayici olmalidir.

Cekme Istegi Inceleme Sureci (PR Review Process)

  1. Otomatik Kontroller: PR acildiginda otomatik dogrulama betikleri (validation scripts) calistirilir.
  2. Kod Incelemesi (Code Review): En az bir proje sahibi (maintainer) tarafindan incelenir.
  3. Geri Bildirim: Gerekli duzenlemeler istenebilir. Lutfen geri bildirimlere zamaninda yanit verin.
  4. Onaylama ve Birlestirme (Approve & Merge): Tum kontroller gecildikten ve onay alindiktan sonra PR ana dala birlestirilir.

PR Kontrol Listesi

PR gonderirken asagidaki kontrolleri yaptiginizdan emin olun:

  • Kod PEP 8 standartlarina uygun mu?
  • Yorum satirlari Turkce + Ingilizce formatinda mi?
  • Commit mesajlari belirlenen formata uygun mu?
  • XMI dosyalari gecerli XML formatinda mi?
  • Ilgili dokumantasyon guncellendi mi?

Davranis Kurallari (Code of Conduct)

Bu proje, katilimcilarin birbirine saygi gostermesini ve yapici bir ortam olusturmasini bekler. Lutfen asagidaki kurallara uyun:

  • Saygi cercevesinde iletisim kurun.
  • Yapici elestiri ve geri bildirimde bulunun.
  • Ayrimcilik, taciz ve kotu niyetli davranislardan kacinin.
  • Farkli goruslere ve deneyimlere acik olun.

Davranis kurallariyla ilgili ihlaller proje sahiplerine bildirilebilir. Detayli bilgi icin projenin davranis kurallari (Code of Conduct) belgesine basvurunuz.

Bu rehber, projenin gelisimine katkida bulunan herkese tesekkur eder. Katkilariniz bu projeyi daha iyi hale getirmektedir!