Proje rehberleri

Açık kaynak depo için CONTRIBUTING.md şablonu

CONTRIBUTING.md dosyası, birinin “Yardım etmek istiyorum” düşüncesinden yararlı bir sorun kaydına veya çekme isteğine geçmesine yardımcı olur. Desteklenen en küçük katkıyı ve nasıl doğrulanacağını açıklayın. Gereksinimler, kimsenin izlemediği iddialı bir süreci değil, projenizin gerçekten nasıl çalıştığını yansıtmalıdır.

GitHubStart yayın ekibi · Güncellendi

Katkı şablonunu kopyalayın ve uyarlayın

Yer tutucuları değiştirin, her komutu ve bağlantıyı doğrulayın. Katkıda bulunan kişi uygulama kodunu değiştirmeye hazır olmasa bile belge düzeltmelerini ve hata raporlarını memnuniyetle karşılayın.

# Katkıda bulunma

## Başlamadan önce
README dosyasını okuyun ve mevcut sorun kayıtlarını kontrol edin.
Büyük değişikliklerde uygulamaya geçmeden önce yaklaşımı tartışın.

## Yerel kurulum
[Gerekli çalışma zamanı ve doğrulanmış kurulum komutları]

## Hata bildirme
Sürümü, ortamı, adımları, beklenen sonucu ve gerçek sonucu ekleyin.
Günlüklerden gizli bilgileri ve kişisel verileri kaldırın.

## Çekme isteği gönderme
- Sorunu ve önerilen değişikliği açıklayın.
- Değişikliği odaklı tutun.
- [Projeye özgü kontrolleri] çalıştırın.
- Etkilenen belgeleri güncelleyin.

## İnceleme
[Kimin incelediği, nasıl yanıt verileceği ve gerçekçi müsaitlik]

## Yardım etmenin diğer yolları
[Belgeler, örnekler, çeviriler veya yeniden üretilebilir raporlar]

Yönergeleri kolay bulunur hâle getirin

GitHub, depo kökünde, docs veya .github dizinlerinde bulunan katkı yönergelerini tanır. README dosyanızdan da bu dosyaya bağlantı verin; böylece proje girişini okuyan biri süreci hemen bulabilir.

Deponun gerçek katkı giriş noktalarından başlayan yolu inceleyin. Birden fazla yönerge dosyası varsa çelişen talimatları uzlaştırın. Katkıda bulunan kişi README içinde bir kurulum komutu, katkı kılavuzunda ise desteklenmeyen farklı bir komut görmemelidir.

Kolay başlanabilecek bir ilk katkı tasarlayın

Desteklenen bir çalışma zamanı için örneği düzeltmek gibi, sonucu açık olan küçük bir görev seçin. Sorunun nasıl yeniden üretileceğini, hangi davranışın değişmesi gerektiğini ve tamamlanmanın nasıl kontrol edileceğini açıklayın. Belgelenmemiş iç bilgi gerektiren bir görevi başlangıç düzeyine uygun olarak etiketlemeyin.

İnceleme için müsaitliğinizi dürüstçe belirtin. Yanıt süresi sözü veremiyorsanız katkıda bulunanların durumu nasıl kontrol edebileceğini söyleyin. Açık sınırlar yarım bırakılan işi azaltır ve her katkıyı birleştirme sözünden daha yararlıdır.

Sık sorulan sorular

CONTRIBUTING.md, README.md dosyasının yerini alır mı?

Hayır. README projeyi ve nasıl kullanılacağını açıklar. Katkı yönergeleri değişikliklerin nasıl önerileceğini ve doğrulanacağını açıklar.

Başka bir projenin test komutlarını kopyalamalı mıyım?

Yalnızca sizin projeniz için de doğru komutlarsa. Yer tutucuları gerçekten kontrol ettiğiniz komutlarla değiştirin.

Katkı yönergeleri daha fazla katkıcıyı garanti eder mi?

Hayır. İlgilenen kişiler için belirsizliği azaltırlar, ancak projenin yararlılığı, görev kalitesi ve bakımcının takibi önemini korur.

Kaynaklar