README dosyaları nedir ve nasıl doğru şekilde kullanılır?

Dijital projelerle çalışıyorsanız, er ya da geç "dosya" olarak adlandırılan bir dosyayla karşılaşacaksınız. READMEİlk bakışta basit bir metin belgesi gibi görünse de, göründüğünden çok daha önemlidir: o, projeniz için ön yazıBu, yaptığınız işi, nasıl kullanacağınızı ve zaman ayırmaya değer olup olmadığını öğrenmek isteyen herkes için ilk giriş noktasıdır.

Yazılım geliştirme, veri bilimi dünyasında, hatta akademik çalışmalarda ve işbirlikçi projelerde bile, bir README dosyası iyi yazılmış. Bu, size zaman kazandırır, hataları önler ve başkalarının (hatta birkaç ay sonra kendinizin bile) projenin amacını hızlıca anlamasını kolaylaştırır. Gelin, README dosyalarının ne olduğunu, ne işe yaradığını, neleri içermesi gerektiğini ve onlardan en iyi şekilde nasıl yararlanılacağını daha yakından inceleyelim.

README dosyası tam olarak nedir?

README dosyası bir dijital bir projeye eşlik eden metin belgesi Ana amacı, projenin ne içerdiğini, ne işe yaradığını ve nasıl kullanılacağını açıkça açıklamaktır. Kelime anlamıyla "beni oku" gibi bir şeydir ve işlevi de tam olarak budur: birisi bir depoyu, veri klasörünü veya yazılım paketini açtığında okuduğu ilk şey olmak.

Bu dosya türü farklı şekillerde kaydedilebilir. metin biçimleri: klasikten readme.txt (düz metin) kadar readme.doc, readme.1st veya daha az yaygın uzantılar gibi . BanaBelirli format genellikle şuna uyarlanır: işletim sistemi ve görüntüleneceği programBöylece herhangi bir kullanıcı dosyayı hiçbir zorluk yaşamadan açıp okuyabilir.

Günümüzde, özellikle yazılım projelerinde ve kod depolarında en yaygın format şudur: README.md.md uzantısı, dosyanın hangi dilde yazıldığını gösterir. MarkdownHTML, metni biçimlendirmek için yalnızca birkaç sembol kullanarak HTML'ye dönüştürmenizi sağlayan çok basit bir işaretleme dilidir. Bu, içeriği biçimlendirmeyi kolaylaştırır. Hem ham haliyle hem de web üzerinde işlenmiş haliyle okunması kolay.Başlıklar, listeler, bağlantılar, tablolar, resimler ve daha fazlasını sorunsuz bir şekilde eklemeye olanak tanır.

İyi yapılandırılmış bir README dosyası, kullanıcıya veya katkıda bulunana şunları sunar: Projenin eksiksiz ve anlaşılır özetiBu, kapsamlı bir belge olmaktan ziyade, projenin ne işe yaradığını, neden faydalı olduğunu, nasıl kullanılmaya başlanacağını ve gerekirse daha fazla bilgiye nereden ulaşılacağını anlatan pratik bir kılavuzdur.

Veri alanında, örneğin veri seti depolarında, README dosyasının (bazen şu formatta) şu şekilde olması çok yaygındır: readme.txt) TOPLAMAK Genel bilgiler, yazarlık, anahtar kelimeler, coğrafi ve zamansal kapsam, kullanım lisansı ve metodoloji Verileri oluşturmak veya toplamak için kullanılanlar ve ayrıca Onlarla çalışmak için önerilen yazılım.

README dosyalarının kısa tarihi ve standart kullanımı

Günümüzde çoğunlukla GitHub gibi platformlarla ilişkilendirsek de, yazılım paketlerine README dosyası ekleme uygulaması aslında şuradan geliyor: on yıllar önceBunun belgelenmiş örnekleri geçmişe dayanmaktadır. 70'lerin ortalarıProgramlar zaten içeriklerini ve kullanımlarını açıklayan küçük bir dokümanla birlikte dağıtılıyordu.

Zamanla bu uygulama o kadar yerleşti ki, GNU Kodlama Standartları (GNU kodlama standartlarına göre) README dosyası şu şekilde kabul edilir: bir gereklilikBu standartlar, özgür yazılım ekosistemini büyük ölçüde etkiledi ve README dosyasının neredeyse her ciddi yazılım paketinde zorunlu hale gelmesine katkıda bulundu.

İnternetin ortaya çıkışıyla birlikte... yazılım dağıtımı için standart platformBirçok proje, daha önce README dosyasında bulunan bilgilerin (kılavuzlar, lisans, haberler vb.) bir kısmını web sitelerine, vikilere veya diğer platformlara taşımaya başladı. kaynak kod tarball paketiBununla birlikte, README dosyası hiçbir zaman ortadan kaybolmadı: çoğu durumda olduğu gibi kaldı. yerel özetAncak bazen çevrimiçi belgelere kıyasla biraz eksik kalıyordu.

Gibi platformların popülaritesi GitHub Daha köklü özgür yazılım topluluklarının çabaları, README dosyalarını yeniden ön plana çıkardı. Örneğin GitHub'da, bir depoda kök dizinde bir README dosyası varsa, sistem bunu otomatik olarak ekler. Otomatik olarak HTML'ye dönüştürülür ve ana sayfada görüntülenir. Projenin bir parçası olduğu için içeri girdiğinizde ilk gördüğünüz şey bu oluyor.

Ayrıca, "readme dosyası" kavramı bazen şu amaçlarla kullanılır: Genel Bir klasörün veya projenin içeriğini açıklayan herhangi bir kısa belgeye atıfta bulunmak için kullanılır; dosyanın adı tam olarak README olmasa bile. Birçok özgür yazılım projesi, README ile birlikte her birinin iyi tanımlanmış bir işlevi olan standart bir dosya seti dağıtır.

README dosyasına eşlik eden tipik dosyalar

Örneğin, şu gibi standartlara uyan projelerde: Gnits Standartları veya aşağıdaki gibi araçlarla oluşturulanlar GNU AutotoolsAna README dosyasına ek olarak, proje bilgilerini tamamlayan başka metin dosyalarına da rastlamak yaygındır. Bunlardan en tipik olanları şunlardır:

• READMEProje hakkında genel bilgiler, amacı ve genel vizyonu.
• YAZARLAR: Başlıca yazarların veya işbirlikçilerin listesi.
• TEŞEKKÜRLERYardımcı olan kişi veya kurumlara teşekkürler.
• CHANGELOG: Ayrıntılı değişiklik günlüğü, öncelikle geliştiriciler için tasarlanmıştır.
• HABERLERSon kullanıcılar için daha özlü ve anlaşılır bir değişiklik günlüğü.
• INSTALL: özel kurulum talimatları ve teknik gereksinimler.
• KOPYALAMA / LİSANSYazılımın kullanım ve dağıtım lisansının metni.
• BÖCEKBilinen hatalar ve bunların doğru şekilde nasıl raporlanacağı.
• SSSSıkça sorulan sorular ve cevapları.
• YAPILACAKLARTamamlanması beklenen görevlerin ve planlanan gelecekteki iyileştirmelerin listesi.

Tüm bu belgeler, README dosyasıyla birlikte, şu yapıyı oluşturur: temel dokümantasyonun iskeleti Birçok pakete ait bilgiler mevcuttur. Bazı durumlarda, farklı kanallardan erişimi kolaylaştırmak için bu bilgilerin bir kısmı hem depoda hem de proje web sitesinde tekrarlanır.

GitHub ve benzeri platformlarda README'nin rolü

GitHub'da README dosyası özellikle önemli bir rol oynar. Her şeyden önce, genellikle şu şekildedir: herkesin ilk gördüğü şey ziyaret eden deponuzDosya iyi hazırlanmışsa, birkaç saniye içinde projenin ne yaptığı, neden ilgi çekici olabileceği, nasıl çalıştırılacağı ve kimin arkasında olduğu açıkça anlaşılacaktır.

GitHub, README dosyasını belirli depo konumlarına yerleştirildiğinde otomatik olarak tanır. Eğer dosyayı şu klasöre koyarsanız: .github, In kök dizin veya klasörde docsPlatform bunu algılıyor ve belirgin bir şekilde sergiler Ziyaretçilere. Birden fazla README dosyası olduğunda, GitHub aşağıdaki yöntemi izler: öncelik sırası: ilk arama .githubönce kökte, sonra da nihayetinde docs.

Ayrıca, adı tam olarak sizinle eşleşen herkese açık bir depo oluşturursanız kullanıcı adı Kök dizine bir README dosyası eklerseniz, bu dosya otomatik olarak sizin README dosyanız olur. Profil READMEBu özellik, kullanıcı sayfanızda görüntülenir ve GitHub Flavored Markdown kullanarak özel bir sunum bölümü oluşturmanıza olanak tanır.

GitHub'da bir README (veya herhangi bir .md dosyası) görüntülendiğinde, platform otomatik olarak bir README dosyası oluşturur. İçindekiler Belge başlıklarına göre oluşturulmuştur. Bu dizini, "Anahat" simgesine tıklayarak görüntüleyebilirsiniz; bu da birden fazla bölüm içeren uzun README dosyalarında gezinmeyi çok daha kolaylaştırır.

GitHub ayrıca şunlara da izin veriyor: Belirli bölümlere doğrudan bağlantıHer başlık otomatik olarak bir bağlantı oluşturur; başlığın üzerine fareyle geldiğinizde bağlantı simgesi görünür. Bu sayede, README dosyasının vurgulamak istediğiniz belirli bölümüne (örneğin, kurulum veya katkılar bölümüne) doğrudan işaret eden URL'leri paylaşabilirsiniz.

Önemli bir pratik ayrıntı var: performans nedenleriyle, README dosyanız belirtilen boyutu aşarsa... 500 KiB boyut, GitHub içeriği kısaltacaktır Bu noktadan itibaren, görüntülenen resimde değişiklikler olacaktır. Bu nedenle, README dosyasını yalnızca temel bilgiler için ayırmanız ve uzun eğitim veya kılavuzları wiki'lere veya ayrı belgelere taşımanız önerilir.

README dosyasındaki format ve bağlantılar

README dosyasının bakımının kolay olması ve hem GitHub'da hem de yerel kopyalarda sorunsuz çalışması için aşağıdaki yöntemin kullanılması önerilir: bağıl bağlantılar ve resim yolları, bulundukları dosyaya göre görecelidir. Yani, örneğin, kök dizinde bir README dosyanız ve bir belgeniz varsa. docs/CONTRIBUTING.mdREADME dosyasındaki bağlantı yaklaşık olarak şöyle görünür: (docs/CONTRIBUTING.md).

Bu tür göreceli bağlantı, dallar arasında geçiş yaparken veya depoyu klonlarken şu anlama gelir: Rotalar doğru şekilde çalışmaya devam ediyor. Bunları değiştirmeye gerek kalmadan. GitHub, görüntülenen dala bağlı olarak bu yolları doğru dosya sürümüne işaret edecek şekilde dahili olarak dönüştürür. ile başlayan yollar /Bunlar, depo kök dizinine göre yorumlanır; ayrıca aşağıdaki gibi yaygın operatörler de bulunur: ./ o ../.

Önemli olan bağlantı metni Bağlantıyı tek satırda tutun, çünkü birden fazla satıra bölmek arızaya neden olabilir. Ayrıca, dahili depo dosyalarına mutlak bağlantılardan kaçının, çünkü temel URL değişirse veya bir çatal oluşturulursa bunlar bozulabilir.

Belgenin kapsamına gelince, README dosyasının yalnızca şunları içermesi gerektiğini hatırlatmakta fayda var: Kullanmaya ve katkıda bulunmaya başlamak için gerekli temel bilgiler Projeye ilişkin kapsamlı dokümantasyon (kullanıcı kılavuzları, eksiksiz API kılavuzları vb.) için, aşağıdaki yöntemi kullanmak daha temiz olacaktır. wiki Ya da README dosyasından bağlantı verilen ayrı bir dokümantasyon sistemi.

README dosyasının asıl amacı nedir?

Teorinin ötesinde, README dosyası pratikte şu şekilde işlev görür: başlangıç ​​kılavuzu ve referans noktasıBu, kapsamlı resmi dokümantasyonun yerini almayı amaçlamamaktadır; aksine, projenin en önemli yönlerine ilişkin düzenli ve pratik bir açıklama sunmayı hedeflemektedir.

En yaygın kullanım alanları şunlardır: amacı açıklayın Projenin içeriğini, içerdiği verileri veya dosyaları açıklayın, nasıl kullanılmaya başlanacağını belirtin ve temel teknik gereksinimleri sıralayın. Yanlış kullanımdan kaynaklanan hatalardan kaçının.Birden fazla kullanıcı aynı kod veya veri üzerinde çalışırken, açık ve anlaşılır bir README dosyası, tekrar tekrar sorulan sayısız soruyu önler.

Paylaşımlı projelerde, özellikle büyük ekiplerde veya açık kaynak topluluklarında, README dosyası neredeyse olmazsa olmazdır. iletişim altyapısı bileşeniBu, beklentileri uyumlu hale getirmeye, projenin olgunluk düzeyini göstermeye, katkının nasıl sağlanacağını tanımlamaya ve (varsa) sunulan desteği netleştirmeye yarar.

Kişisel projelerde bile, hatta sadece siz üzerinde çalışacak olsanız bile, iyi yazılmış bir README dosyası, bir nevi kılavuz görevi görür. uzun süreli hafızaZamanla kararları, bağımlılıkları veya kurulum adımlarını unutmak kolaydır; bunların belgelenmesi, aylar sonra kendi projenizi "yeniden keşfetmek" zorunda kalmaktan sizi kurtarır.

Dolayısıyla README sadece bir formalite değil, iyileştirmeyi sağlayan pratik bir araçtır. organizasyon, iletişim ve sürdürülebilirlik her türlü dijital proje için.

README dosyası oluşturmak ne zaman uygun olur?

Kısaca özetlemek gerekirse, README dosyası oluşturmak iyi bir fikirdir. Kullanılacak, incelenecek veya bakımı yapılacak bir proje olduğunda Orijinal yaratıcısından başka biri tarafından... ve bu, gelecekteki kendinizi de kapsar. Devasa bir açık kaynak kodlu depo olması gerekmez: sadece biraz karmaşık olması veya içeriğin soru işaretleri uyandırması yeterlidir.

README dosyasının özellikle faydalı olduğu bazı örnekler şunlardır: web veya programlama projeleriGereksinimleri, geliştirme süreçlerini, başlatma komutlarını ve çalışma ortamını açıklamanın tavsiye edildiği yer burasıdır. Ayrıca şu konularda da oldukça ilgi çekicidir: Önemli veriler içeren klasörlerBu verilerin neyi temsil ettiğini, kaynağını ve olası sınırlamalarını açıklığa kavuşturmak için.

Diğer tipik bağlamlar şunlardır: hosting üzerinde barındırılan web siteleriBunlar genellikle kurulum talimatlarını içeren bir README dosyası veya şunları içerir: akademik ve teknik çalışmalarREADME dosyasında komut dosyaları, deneyler, kullanılan araçların sürümleri veya sonuçların nasıl yeniden üretileceği açıklanabilir.

En işbirlikçi projelerİster şirket içi ister herkese açık olsun, README dosyası neredeyse zorunludur. Yeni kişilerin projeye daha sorunsuz katılmalarına yardımcı olur ve tüm paydaşlar arasında tutarlı kullanım ve katkı standartlarını korumak için ortak bir referans görevi görür.

İyi bir README dosyasında hangi bilgiler yer almalıdır?

Etkili bir README dosyasının uzun olması gerekmez, ancak kapsamlı olması gerekir. iyi organize edilmiş ve çok açıkHer zaman dahil edilmesi gereken bazı temel bilgiler ve proje türüne bağlı olarak çok değer katan isteğe bağlı içerikler vardır.

En azından, iyi belgelenmiş depoların ve paketlerin çoğu şunları içerir: proje adıbir Hedefin kısa açıklamasıDeponun içeriğinin bir özeti, Kullanım veya kurulum talimatları ve temel gereksinimler (bağımlılıklar, minimum dil sürümü, işletim sistemi vb.).

Ayrıca bazı eklemeler yapılması da şiddetle tavsiye edilir. iletişim veya destek yöntemiBu, basit bir e-posta veya depodaki "Sorunlar" bölümüne bir bağlantı bile olsa, sorun yaşayan herkese sorunlarını nereye ve nasıl bildirecekleri konusunda yol gösterir; böylece kimse kaybolmaz ve kiminle iletişime geçeceğinden emin olamaz.

Temel bilgilere ek olarak, aşağıdaki konularda da bilgi vermek genellikle faydalıdır. oluşturma tarihi veya sürüm güncel, yazarların veya sorumlu kişilerin listesi, kullanım lisansı ve verilerin veya kodun kullanımına ilişkin ilgili tüm bildirimler (örneğin, deneysel bir sürüm olup olmadığı veya üretim için uygun olup olmadığı).

Sıralama okunabilirliği de etkiler: en kritik bilgiler (projenin ne olduğu, ne için olduğu, nasıl kullanıldığı) ilk sırada yer almalıdır. belgenin başındaİkincil ayrıntıları, ek bilgileri veya tarihsel notları sonraya bırakıyoruz. Bu sayede, sadece göz atan biri bile hızlı bir bakışla net bir fikir edinebilir.

Yazılımda tipik bir README içeriği bulunur.

Yazılım projelerinde, README dosyaları genellikle bir adım daha ileri giderek birkaç ek tematik blok içerir. Çoğu durumda, dosya kısaca özetler: kurulum talimatlarıKurulum talimatları, temel kullanım talimatları, bir dosya manifestosu (Her önemli klasörün ne işe yaradığını açıklayın) ve lisansın özetini verin.

Ayrıca, aşağıdaki bölümlerden birini eklemek de yaygındır. geliştirici veya ekip hakkında bilgiProjeye katkıda bulunmanın olası yolları, bilinen hataların listesi ve sık karşılaşılan sorunlar için kısa bir sorun giderme kılavuzu. Tüm bunlar, depoyu ziyaret eden herkesin bilgi sahibi olmasına yardımcı olur. küresel ve pratik bir vizyon Başka yerlerde aramaya gerek kalmadan.

Bazı durumlarda, README dosyası küçük bir bilgi içerebilir. Günlüğü Değiştir Ya da harici bir CHANGELOG dosyasına işaret edilebilir. Özellikle hedef kitle geliştiricilerden ziyade son kullanıcılar olduğunda, sürümler arasındaki ilgili değişiklikleri vurgulayan bir "Haberler" veya "Yenilikler" bölümü eklemek de oldukça yaygındır.

Akademik veya veri depoları bağlamında, içerik açıklamasının yanı sıra, birçok şablon aşağıdaki açıklamaların da yapılmasını önermektedir: Verilerin toplanması veya oluşturulmasına yönelik metodolojiDahil edilen değişkenler, bilgilerin zamansal ve coğrafi kapsamı ve kullanım veya yorumlamaya ilişkin ilgili sınırlamalar.

GitHub'da iletişim aracı olarak README

Bir projeyi GitHub'a yüklediğinizde, README dosyası yalnızca dokümantasyon olmaktan çıkıp aynı zamanda bir bilgi kaynağı haline gelir. iletişim ve sunum unsuruAslında platformun kendisi, ziyaretçilerin projenin neyle ilgili olduğunu hızlıca anlamalarına yardımcı olmak için herhangi bir herkese açık depoya README dosyası eklenmesini önermektedir.

Açıklamalarınızı README dosyasında yapabilirsiniz. Projenin yaptığı şeyNeden faydalı olabileceği, nasıl başlanacağı (örneğin, "Başlangıç" bölümüyle), nereden yardım alınacağı (sorunlar, forumlar, sohbet vb.) ve kodun kim tarafından aktif olarak sürdürüldüğü gibi bilgiler, deponun algılanan kalitesini ve yarattığı güveni etkiler.

Birçok durumda geliştiriciler GitHub depolarını şu amaçlarla kullanırlar: profesyonel portföyBu bağlamda, iyi hazırlanmış README dosyaları büyük fark yaratır: işe alım uzmanlarının veya diğer ilgili tarafların projenin kapsamını, kullanılan teknolojileri ve yazarın çalışma yöntemlerini bir bakışta görmelerini sağlar.

Eğer amacınız katkı çekmek veya depoyu tanıtmak değilse (örneğin, özel veya çok içsel bir proje ise), çok detaylı bir README dosyası zorunlu değildir. Yine de, en az bir tane bulundurmak genellikle pratiktir. minimum temel dokümantasyon Kişisel ve ekip kullanımı için.

GitHub ayrıca README ile ilgili bazı özel araçlar da sunuyor: otomatik olarak bir dizin oluşturuyor, rozetleri ve simgeleri destekliyor ve projeyi sergilemek için resimler, GIF'ler veya videolar eklemenize olanak tanıyor. Tüm bu unsurlar etkili bir şekilde kullanıldığında README'yi daha verimli hale getirebilir. daha çekici ve gezinmesi daha kolay.

README dosyanızı nasıl yapılandırabilir ve geliştirebilirsiniz?

Popüler depoları (örneğin, büyük teknoloji kuruluşlarının veya uzay ajanslarının projeleri) analiz ederken, README dosyalarının genellikle bir dizi ortak özelliğe sahip olduğu gözlemlenmektedir. ortak desenlerHer proje kendi görsel ve içerik kimliğini korusa da.

Sıklıkla rastlanır net bir başlık ve olası bir kapak resmi (proje için bir logo veya afiş gibi), ardından projenin durumunu, lisansını, mevcut sürümünü veya test durumunu özetleyen bazı rozetler gelir. Sonra genellikle bir Proje AçıklamasıDurum hakkında bilgi veren bir bölüm (kararlı, geliştirme aşamasında, deneysel vb.) ve gösterimler veya ekran görüntüleri içeren bir bölüm.

Ayrıca, aşağıdaki özelliklere sahip bir blok bulmak da çok yaygındır. projeye erişim (dağıtılan sürüme, dokümantasyona ve yayınlanmış paketlere bağlantılar), kullanılan teknolojilerin listesi, katkıda bulunanlara, geliştiricilere ve elbette ki lisansBu unsurlar, README dosyasının hem kullanıcılar için hızlı bir kılavuz hem de potansiyel katkıda bulunanlar için bir kartvizit görevi görmesine yardımcı olur.

Tasarım konusuna gelince, bir metin dosyasından bahsediyor olsak da, okunabilirliğini artırmak için bolca alan var: iyi yapılandırılmış başlıklar, sıralı ve sırasız listeler, uygun yerlerde tablolar kullanın ve Önemli fikirleri vurgulamak için kalın metin kullanılmıştır.Markdown'da, kullanıcı dostu hale getirmek için resimler, GIF'ler ve küçük süslemeler (emoji gibi) ekleyebilirsiniz; ancak her zaman anlaşılırlığı göz önünde bulundurun.

Az bilinen bir yöntem, her zaman aklınızda birisini düşünerek yazmaktır. Proje hakkında kesinlikle hiçbir şey bilmiyor.Bu, önceden edinilen bilgilere dair varsayımlardan kaçınmak, açık ve doğrudan bir dil kullanmak ve teknik terimleri ilk kez göründükleri yerde açıklığa kavuşturmak anlamına gelir. Ve elbette, projede ilgili bir şey değiştiğinde README dosyasını güncel tutmak gerekir.

Lisans, katkılar ve yazarlık

Açık kaynak projelerinde, README dosyasının özellikle önemli bir bölümü, şunlara ayrılmış olan bölümdür: lisansKodun herkese açık bir depoda yayınlanması, onu otomatik olarak özgür yazılım yapmaz; hangi koşullar altında özgür yazılım olarak kabul edilebileceğinin açıkça belirtilmesi gerekir. kullanılmak, değiştirilmek ve yeniden dağıtılmak üzere.

En yaygın uygulama, bilinen lisansları (MIT, Apache, GPL, dokümantasyon için Creative Commons vb.) kullanmak ve README dosyasından deponun LICENSE veya COPYING dosyasına bağlantı vermektir. Bu şekilde, ilgilenen herkes kodla ne yapabileceğini ve yükümlülüklerinin neler olduğunu (örneğin, kaynak gösterme, paylaşım, sorumluluk sınırlamaları vb.) hemen anlar.

Olgun bir README dosyasındaki bir diğer önemli bölüm ise şudur: katkı kılavuzuBu bölüm, başkalarının projeye nasıl katkıda bulunabileceğini açıklar: stil yönergeleri, çekme istekleri gönderme süreci, hataların nasıl bildirileceği, hangi tür katkıların kabul edildiği ve çalışmaların nerede koordine edildiği. Bazen bu bilgiler, README dosyasından bağlantı verilen ayrı bir CONTRIBUTING.md dosyasında yer alır.

Görünür kılmak da iyi bir uygulamadır. katkıda bulunan bireyler ve geliştiricilerBazı projelerde avatarlar ve profillerine bağlı isimler içeren tablolar bulunurken, diğerlerinde sadece ana kullanıcılar listelenir. Bu jest, yapılan çalışmayı takdir etmenin yanı sıra, birinin belirli bir ekip üyesiyle konuşması gerektiğinde doğrudan iletişimi de kolaylaştırır.

Son olarak, birkaç satırda şu konuya açıklık getirmek yerinde olacaktır: nasıl yardım alabilirim Peki hangi kanallar mevcut: GitHub sorunları, forumlar, e-posta listeleri, sohbetler vb. Eğer proje resmi destek sunmuyorsa, yanlış anlaşılmaları önlemek için bunu açıkça belirtmek de geçerlidir.

Yukarıda belirtilenlerin tümü göz önüne alındığında, README dosyası herhangi bir dijital projenin temel bir parçası haline gelir: Bu belge, söz konusu sistemin ne olduğunu, nasıl çalıştığını, kimin bakımını üstlendiğini ve hangi koşullar altında kullanılabileceğini açıklamaktadır.İçeriğinize özen göstermek ve onu güncel tutmak, diğer insanların çalışmalarınızı nasıl algıladığı ve kullandığı konusunda büyük fark yaratan küçük bir yatırımdır.