Kısa bir form doldurun ve kurulum adımları, kullanım, yapılandırma ve lisansla düzenli bir README.md veya Keep a Changelog biçiminde bir CHANGELOG.md alın. Siz yazdıkça sonucu görün. Her şey tarayıcınızda yazılır ve yazdığınız hiçbir şey yüklenmez. Ücretsizdir.
Bir README adım adım nasıl yapılır
- En üstte README.md'yi seçin.
- Proje hakkında altında Proje adını, Tek satırlık özeti, bir Açıklamayı ve satır başına bir olarak Özellikleri ve Gereksinimleri girin.
- Kur ve kullan altında npm, pip veya Cargo gibi bir Paket yöneticisi seçin, Depo URL'sini ekleyin ve Kullanımınızı yazın. Kodun doğru biçimlendirilmesi için Kullanım dilini seçin.
- Geçerliyse Ayarlar ve Geliştirme komutlarını ekleyin.
- Bir Lisans ve Telif hakkı sahibi seçin ve gerektiğinde İçindekiler tablosu, Lisans rozeti veya Katkıda bulunma bölümünü açın.
- README.md'yi kopyala'ya veya README.md indir'e basın.
İyi bir README'yi ne yapar
Projenin ne yaptığını tek satırda söyleyin, sonra nasıl kurulacağını ve çalışan en küçük örneği gösterin. Okuyucular bir projenin uyup uymadığına saniyeler içinde karar verir, bu yüzden özellikler ve gereksinimler sonra gelir, ardından ayarlar, geliştirme komutları, nasıl katkıda bulunulacağı ve lisans. Boş bıraktığınız bölümler dışarıda bırakılır.
İnsanların okuyabildiği değişiklik günlükleri
Değişiklik günlüğü Keep a Changelog'u izler: en yeni sürüm önce, her biri bir tarihle ve değişiklikleri Eklenenler, Değişenler, Kullanımdan kaldırılanlar, Kaldırılanlar, Düzeltilenler ve Güvenlik olarak gruplanmış. Henüz yayınlanmamış değişiklikler için en üstte bir Yayınlanmamış bölümü tutun. Bir depo adresiyle her sürüm bir öncekiyle karşılaştırmaya bağlanır. Daha eski bir sürümü elle ekleyebilir veya commit mesajlarından girdiler oluşturabilirsiniz.
İpuçları
- Çalışan bir kurulum komutunu ve kısa bir kullanım örneğini en üste koyun.
- Lisansı net adlandırın, böylece başkaları kodunuzu nasıl kullanabileceklerini bilir.
- Açıklamayı projeyi nasıl yaptığınızla değil, okuyucu için ne yaptığıyla ilgili tutun.
- Değişiklik günlüğünü yalnızca sonunda değil, her sürümle güncelleyin.
Gizli bilgileri ve derleme dosyalarını bir depodan uzak tutmak için gitignore oluşturucuyu ve env örneği oluşturucuyu kullanın.
Sorular
Commit geçmişimden başlayabilir miyim?
Evet. git log --oneline çıktısını Commit mesajlarından altına yapıştırın. feat:, fix:, perf: vb. yazılan commit'ler doğru gruplara ayrılır ve ünlem işaretiyle işaretlenen uyumsuz değişiklikler etiketlenir. Sonra ifadeyi düzenleyin; commit mesajları geliştiriciler için, değişiklik günlükleri kullanıcılar için yazılır.
Lisans metnini ekliyor mu?
Lisansı adlandıran ve bir LICENSE dosyasına işaret eden bir Lisans bölümü ekler. Lisansın tam metnini o dosyaya koyun; lisansın resmi sayfasında vardır.
Dosyalar nereye gider?
İndir, README.md veya CHANGELOG.md dosyasını cihazınıza kaydeder. Deponuzun en üst düzeyine koyun, kod barındırma siteleri onu proje sayfasında gösterir.
Hangi lisansları seçebilirim?
MIT, Apache 2.0, GPL 3.0, BSD 3-Clause, ISC, MPL 2.0, Unlicense veya Tüm hakları saklıdır ya da bölümü dışarıda bırakın.