Yengas / KYCUBYO

KYÇUBYO içerisinde proje geliştirirken kullanılan teknolojiler hakkında dökümantasyon
5 stars 0 forks source link

KYCUBYO

Bu dökümantasyon KYCUBYO içinde kullanılacak olan araçları, editörleri, yazılım dillerini, kütüphaneleri Türkçe olarak açıklamak ve KYCUBYO içinde bu teknolojiler ile ilgili kimlerin deneyimli olduğunu belirtmek için yazılmıştır.

Dökümantasyon içerisinde karar kılınan her şey issuelar ile takip edilip, ortak bir karar alındıktan sonra eklenmiştir. Burada bulunan herhangi bir karar ile ilgili sorunuz var ise, veya deneyimli kişiler listesine eklenmek istiyorsanız, issue açarak takip edilebilir bir şekilde isteğinizi belirtebilirsiniz.

Bu proje üzerinde haftalık olarak yaptıklarımız'ın özeti ve kulübe yeni katılan arkadaşları yönlendirmek için rehber niteliğinde dökümanlarda bulabilirsiniz.

Döküman İçerikleri

Dökümanın düzenlenmesi, ekleme yapılması

Bu döküman üzerinde verilen herhangi bir karar ile ilgili düzenleme yapmak veya yeni bir teknoloji eklemek isterseniz, ilk önce bir issue açmanız veya varolan bir issue'ya yorum eklemeniz gerekmektedir.

Döküman Düzeni

Dökümanda verilen her bir karar ve kullanılan teknoloji, klasör yapısı kullanarak kategorilendirilmiştir. Klasörler kategoriyi açıklayan bir README.md dosyası bulundurmak zorundadır. Eklemek istediğiniz karar ile ilgili ek döküman veya dosya(konfigürasyon vb.) bulundurmak isterseniz, bu karar için bir klasör oluşturup, karar ile ilgili detayları README.md dosyasında yazabilirsiniz.

İçerik Düzeni

Her bir karar bu kararı vermek için kullanılan issue'ya, ve ilgili teknoloji üzerinde deneyimli kişilere bir referans içermek zorundadır.

Örnek Döküman Düzeni

.
├── İşletim Sistemleri
├── Proje Geliştirme                 # Proje Geliştirme kategorisinde verilen kararlar
│   ├── Mesajlaşma Uygulamaları
│   ├── Proje Takip ve Yönetimi
│   └── Versiyon Kontrol             # Proje Geliştirmenin bir alt kategorisi, Versiyon Kontrol ile ilgili kararlar
│       ├── README.md                # Versiyon Kontrol kategorisini açıklayan bir yazı
│       ├── Git.md                   # Git kararını açıklayan bir yazı, ilgili issue ve deneyimli kişiler
│       └── Uzak Depolama
│           ├── README.md            # Uzak Depolama kategorisini açıklayan bir yazı
│           └── Github
│               ├── README.md        # Github kararını açıklayan bir yazı, ilgili issue ve deneyimli kişiler
│               └── Student Pack.md  # Github ile ilgili ek bir döküman
├── Yazılım Dilleri
├── Yazılım Geliştirme Araçları
│   └── Editörler
└── README.md                        # Bu dökümanı açıklayan bir yazı ve dökümanın yönetimi/düzeni hakkında bilgiler