Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
54 lines (37 sloc) 2.44 KB

Katkıda Bulunma

Kodsal bir katkıda bulunmak için lütfen README dosyasındaki Kurulum kısmını okuyun.

Varolan Bir Jargonu Düzenleme

Varolan bir jargonu düzenlemek için ana dizinde bulunan jargons klasöründeki ilgili markdown dosyasını düzenleyip pull request açabilirsiniz.

Yeni Jargon Ekleme

Yeni jargon eklemek için ana dizinde bulunan jargons klasörü içinde yeni bir markdown dosyası oluşturun.

️️⚠️ Dosya adı tamamen alfanümerik küçük harflerden oluşmalı ve boşluk yerine - karakteri kullanılmalıdır.

Bu markdown dosyası içinde frontmatter olarak aşağıdaki tablo oluşturulmalıdır.

Ad Tip Zorunlu Mu Açıklama
title string evet Jargon adı, tamamen küçük harflerle boşluklu veya Türkçe karakterler yazılabilir.
sameWith array hayır Aynı anlama gelen diger jargonlar. (Örnek: immutable için immutability)
tags array hayır Jargon etiketleri, tamamen küçük harflerle yazılmalıdır. En az bir tane olursa güzel olur.

Markdown dosyasının geri kalan kısmında jargon ile ilgili açıklamalar yazılır. Açıklamada kullanılan başka jargon varsa bu jargonlara link verilmesi güzel olur. Daha önce jargon.ist üzerinde tanımlanmamış bir jargon kullanımında onun için de pull request açan contributor ise en güzel contributor 🚀👊'dır.

Açıklamalar yazılırken eğer jargon birden fazla alanda kullanılıyorsa açıklama için kapsam belirtmek, okuyucunun konuya daha rahat hakim olmasını sağlayacaktır. Örnek olarak bias terimi anlatılırken cümleye machine learning için bias şu şu anlama gelmektedir şeklinde başlamak daha okunabilir bir doküman hazırlamanızı sağlar.

Tüm değişiklikler yapıldıktan sonra new-jargon label'ı ile pull request açılır.

Örnek bir Jargon dosyası

---
title: jargon başlığı
sameWith:
- aynı anlama gelen başka bir jargon
tags:
- bir etiket
- bir başka etiket
---

Jargon ile ilgili **açıklama** satırları ve [baska jargon](/baska-jargona-link).

```js
function add(x, y) {
  return x + y;
}
```

Açıklamanın devamı.