numex_nedir/CONTRIBUTING.md

54 lines
2.3 KiB
Markdown
Raw Permalink Normal View History

# 🤝 Katkı Rehberi
Numex'in tanıtım ve dokümantasyon deposuna katkı vermek istediğin için teşekkürler! 🇹🇷
*(English below.)*
## Neler kabul ediyoruz?
| Katkı | Örnek |
|---|---|
| ✏️ **Düzeltme** | Yazım hatası, bozuk link, eski bilgi |
| 🌍 **Çeviri** | `README.en.md`'yi geliştirmek, yeni dil eklemek (`README.<dil>.md`) |
| 📚 **Makale** | `makaleler/` altına Numex kullanım deneyimi, rehber, karşılaştırma |
| 💡 **Örnek** | Numex CLI / SDK / API ile yaptığın bir projenin anlatımı |
| 🖼️ **Görsel** | Güncel ekran görüntüleri (`gorseller/`, kişisel bilgiler gizlenmiş olmalı) |
Ürünlerdeki **hata ve istekler** için lütfen *Hata bildir* veya *Özellik isteği* şablonuyla bir
[issue](../../issues/new/choose) aç.
## Nasıl katkı verilir?
1. Depoyu **fork**'la (çatalla).
2. Yeni bir dal aç: `git checkout -b duzeltme/codex-sayfasi`
3. Değişikliğini yap. Markdown'da mevcut sayfaların yapısına ve üslubuna uy.
4. Göreli linklerin çalıştığını kontrol et.
5. Açıklayıcı bir commit mesajı yaz: `Codex sayfasına kısayol tablosu ekle`
6. **Pull Request** aç; ne değiştiğini ve nedenini kısaca yaz.
## Yazım kuralları
- **Dil:** Türkçe metinlerde sade, günlük Türkçe (*"yapılmaktadır"* değil *"yapılır"*).
- **Doğruluk:** Rakamlar ve özellikler numexai.com.tr'deki güncel bilgilerle uyumlu olmalı. Emin
olmadığın iddiayı ekleme.
- **Gizlilik:** Ekran görüntülerinde e-posta, token, cihaz kimliği, API anahtarı gibi bilgileri gizle.
- **Görseller:** PNG, genişlik en fazla 1600 px.
## Davranış
Tüm katkılar [Davranış Kuralları](CODE_OF_CONDUCT.md)'na tabidir.
## Güvenlik
Numex ürünlerinde bir **güvenlik açığı** bulduysan herkese açık issue açma; doğrudan
**destek@numexai.com.tr** adresine yaz.
---
## 🇬🇧 English
Thanks for helping! We welcome fixes, translations (`README.<lang>.md`), articles in `makaleler/`,
usage examples and up-to-date screenshots (with personal data hidden). Fork → branch → change →
pull request. For product bugs and feature requests, open an [issue](../../issues/new/choose).
Report security issues privately to **destek@numexai.com.tr**. All contributions follow our
[Code of Conduct](CODE_OF_CONDUCT.md).