CONTRIBUTING.md

description
Projeye katkı sağlamak isteyenler için bilgilendirme

💖 Katkıda Bulunma Rehberi

💡 İçerik Desteğinde Bulunma veya Fikir Belirtme

• 📙 Ders notun, ders notu ihtiyacın, tavsiyelerin veya hata tespitlerin varsa 🦋 Issue açabilirsin
  • 📈 Bu yapı sayesinde aranan dersler daha belirgin olacaktır.
• 💡 Yapıcı eleştirileriniz veya fikirleriniz varsa sağ üst köşedeki 🏹 Edit on Github alanından fikirlerinizi belirtebilirsiniz

📌 Formata (markdown'a) uygun şekilde katkıda bulunursanız hoş olur 😊

📙 Ders Notları Ekleme

Açık kaynaklı projeye ders notların ile katkı sağlamak için:

• 💫 Ders notlarınızı 📕 Online2PDF ile PDF'e çeviriniz.
• 👮‍ Adlandırma Kuralı'na göre adlandırın
• 🚙 Dosya Konumlandırması'na göre alaklı dizinine koyun
• ⏫ GitHub üzerinde dosya yükleme alanı işine yaracaktır.

👨‍💻 Dosyaya link vermene gerek yoktur, scriptim ile otomatik halletmekteyim.

👮‍ Adlandırma Kuralı

Adlandırma kuralı <yıl> <tip> <ders_kodu> ~ <sahibi> şeklindedir.

👮‍ Kural	📜 Açıklama
Yıl	2019, 2020
Tip	Vize, Final, Quiz, tüm notlar için Tam vs
Ders Kodu	Dersinin adının baş harfleri (NYP Nesneye yönelik programlama)
Sahibi	Hocanın verdiği notsa boş bırakın, aksi halde isminiz ✨

🚙 Dosya Konumlandırması

⭐ Örnek Dosya İsmi	📁 Koyulması gereken yer
2018 Final Notu BM ~ YEmreAk.pdf	3. Sınıf 2. Dönem Notları/Bilgisayar Mimarisi/Öğrenci Notları
2018 Final BM.pdf	3. Sınıf 2. Dönem Notları/Bilgisayar Mimarisi/Sınav Soruları
2018 Tam Calculus ~ Asma Mirkhan.pdf	1. Sınıf 1. Dönem Notları - Calculus 1 - Öğrenci Notları

📑 İçerik Yazma Formatı

Başlık ile alakalı bir emoji koyman verimlilik adına çok etkilidir.

• Windows üzerinde, ❖ Win Ş ile emoji klavyesini açabilirsin
• Linux için 😎 Emoji Selector eklentisini kullanabilirsin

## 🌟 Başlık

Giriş cümlesi veya alakalı cümle.

- Alaklı maddesel bilgiler
- Bilgi 2

> Varsa ek yorum

<!-- Tablo oluşturman gerekiyorsa -->
| Tablo        | Tablo1                      |
| ------------ | --------------------------- |
| `<değişken>` | Tablosal yapı ile örnekleme |

- `<değişken>` Tablo değişkenlerini açıklama
  - Örn: `kod` örneklendirme


<!-- Tek bağlantı varsa -->
> [Kaynak ismi](https://yemreak.com)

<!-- Birden fazla bağlantı varsa -->
> Ek bağlantılar:
>
> - [Link](https://yemreak.com)
> - [Link](https://yemreak.com)
> - [Link](https://yemreak.com)

✍ Çalışma Notları

Markdown hakkında detaylı açıklamalara 📑 Markdown bağlantısından erişebilirsin

• Her şey dinamik olmalı
• Önemli notlar ve başlıklar bold
• Butonlar ve tıklanabilir öğeler button <kbd>button</kbd>
• Terimler italik _italik_
  • Önce normal yaz, sonrasında ✲ Ctrl + H ile metinleri italik hale dönüştür
• Kalıplar ve sabit ifadeler ` arasına yazılmalı
• Kodlar ``` arasına yazılmalı
• Matematikler (latex) $latex$ $$latex$$ (gitbook) veya $latex$ (github)

🏃‍ Web Üzerinden Projeye Hızlıca Katkıda Bulunma

GitHub projelerini clone yapıp, internetini harcamak yerine web üzerinden katkıda bulunabilirsin.

• ile online sanal makineden işlemlerinizi yapabilirsiniz
• Katkı sağlama işlemi GitHub hesabı gerektirir.
• Güncel bilgiler için 🌍 GitHub Web yazıma bakabilirsin

Videolar faydalı olmadıysa bana WhatsApp veya Mail üzerinden atabilirsin.

⚓ GitHook'lar

💫 GitBook İndekslemesini Yapma

Projeyi güncelleme işlemi için alttaki komutları veya integrate.sh scriptini kullanın

• pip3 install ypackage ile ypackage paketimi indirin
• ygitbookintegration . -ur -ll 2 komutu ile entegrasyonu sağlayın

Komut hakkında detaylar için ygitbookintegration -h yazabilirsiniz.

👀 Neler Değişti Commit'i Tanımlama

#!/bin/sh
# .git/hooks/pre-push dosyasında

remote="$1"
url="$2"

echo "---
description: Sitede neler olup bittiğinin 📜 raporudur. Buradaki terimleri 🔍 arama motorunda aratarak sayfaya erişebilirsin
---
" > CHANGELOG.md && \
ygitchangelog.exe >> CHANGELOG.md && git add CHANGELOG.md && git commit -m "👀 Neler Değişti alanı yenilendi" && exit 0