vcpkg PR Gözden Geçirme Denetim Listesi

Düzeltme: 1

Genel Bakış

Bu belge, vcpkg ekip üyelerinin gelen çekme isteklerine "gözden geçirildi" etiketini uygulamak için kullandığı ek açıklamalı bir denetim listesi sağlar. Çekme isteği bu noktalardan herhangi birini ihlal ederse, değişiklik kümesini birleştirmeden önce katkıda bulunanlardan gerekli değişiklikleri yapmalarını isteyebiliriz.

Bu denetim listesinin geliştirilebileceğini düşünüyorsanız sorun veya çekme isteği oluşturmaktan çekinmeyin. Denetim listesi içeriğini değiştirirken lütfen düzeltme numarasını artırın.

Denetim listesi

Her öğe koduna eklenen bağlantı adresini kopyalayarak gitHub açıklamasında bu denetim listesi öğelerinden herhangi birini bağlayabilirsiniz.

c000001: Kullanım dışı bırakılmış yardımcı işlev kullanılmaz

Daha fazla bilgi için Bakımcı Yönergelerimize ve İlkelerimize bakın.

c000002: '"port-version"' alanı güncelleştirildi

Daha fazla bilgi için Bakımcı Yönergelerimize ve İlkelerimize bakın.

c000003: Yeni bağlantı noktaları İngilizce yazılmış bir '"description"' alanı içeriyor

Yalnızca bir veya birkaç cümle uzunluğunda bir açıklama yararlı olur. Mümkünse kitaplığın resmi açıklamasını kendilerinden veya benzerlerinden README.md kullanmayı göz önünde bulundurun. Otomatik çeviriler kabul edilebilir ve katkıda bulunanlarımız için İngilizce çevirileri temizlemek için mutluyuz.

Daha fazla bilgi için bildirim dosyası belgelerimize bakın.

c000004: Değişiklik kümesinde gereksiz açıklamalar yok

Daha fazla bilgi için Bakımcı Yönergelerimize ve İlkelerimize bakın.

c000005: İndirilen arşivler varsa

sürümü oluşturulur Arşiv içeriğinin değişmediğinden emin olmak için, indirilen arşivler tercihen bağlantı noktasının "version"yanında artırılabilir ilişkili bir sürüm etiketine sahiptir.

c000006: Yeni bağlantı noktaları, kitaplığın resmi olarak desteklediği üçlüler için CI denetimlerini geçirir

Vcpkg bağlantı noktalarının yüksek kalitede olduğundan emin olmak için, gelen bağlantı noktalarının söz konusu kitaplık için resmi platformları desteklemesini istiyoruz.

c000007: Düzeltme ekleri yalnızca vcpkg'ye özgü sorunları düzeltir

Mümkünse, kitaplık kaynak koduna yapılan düzeltme ekleri kitaplığın resmi deposuna yukarı akışla aktarılmalıdır. Kitaplığın deposunda bir çekme isteği açmak, kitaplığı yalnızca vcpkg kullanıcıları için değil, herkes için iyileştirmeye yardımcı olur.

c000008: Yeni bağlantı noktaları varsa resmi kaynaktan kaynak kodunu indirir

Kitaplık yazarlarına saygı ve kodun güvenliğini sağlamak için lütfen bağlantı noktalarının kaynak kodunu resmi kaynaktan indirmesini sağlayın. Özgün kaynak kodu kullanılamıyorsa ve söz konusu kitaplığın bakımını yapmak için önemli bir topluluk ilgi alanı varsa özel durumlar yaşayabiliriz.

c000009: Bağlantı noktaları ve bağlantı noktası özellikleri doğru adlandırılıyor

Kullanıcı erişilebilirliği için, bağlantı noktası ve bağlantı noktası özelliklerinin adlarının sezgisel olmasını ve resmi kaynaklarda ve diğer paket yöneticilerindeki karşılıklarına yakın olmasını tercih ediyoruz. Bağlantı noktası veya bağlantı noktası özelliğinin adlandırılmasından emin değilseniz, arama altyapısını kullanarak repology.org, packages.ubuntu.com denetlemenizi veya ek bilgi aramanızı öneririz. Katkıda bulunanlarımıza bu konuda da yardımcı olabileceğimizden emin değilseniz adlandırma önerileri isteyebilirsiniz.

c000010: Kitaplık hedefleri uygun olduğunda dışarı aktarılır

Kullanıcılara sorunsuz bir derleme sistemi tümleştirmesi sağlamak için lütfen dışarı aktarıp aşağı akışta kullanılması amaçlanan kitaplık hedeflerini bulmanın bir aracı olduğundan emin olun. Dışarı aktarılması amaçlanmamış hedefler özel olarak işaretlenmeli ve dışarı aktarılmamalıdır.

c000011: Bağlantı noktaları kullanıcının sistemini değiştiren uygulamaları kullanmaz

Bağlantı noktaları, bunu yapan uygulamalardan kaçınarak vcpkg'nin kullanıcının sistemini değiştirmeme sözleşmesini izlemelidir. Bu uygulamalara örnek olarak sudo, apt, brewveya pipverilebilir. Lütfen mümkün olduğunca bu tür programlar için bir alternatif kullanın.

c000012: Sistem bağımlılıklarına sahip bağlantı noktaları yükleme sırasında bir bilgi iletisi içerir

Bazı bağlantı noktalarının vcpkg içinde var olmayan kitaplık ve araç bağımlılıkları vardır. Bu eksik bağımlılıklar için katkıda bulunanların bağlantı noktasının portfile.cmake üst kısmına eksik bağımlılıkları ve bunların nasıl alındığını belirten bir ileti eklemelerini istiyoruz. Kullanıcıların bağımlılıkları eksik olması durumunda yükleme işleminden en kısa sürede "erken çıkabilmesini" sağlamak için büyük bir çalışma yapılmadan önce iletinin görüntülenmesini istiyoruz.

Örneğin:

message(
"${PORT} currently requires the following libraries from the system package manager:
    autoconf libtool
These can be installed on Ubuntu systems via sudo apt install autoconf libtool"
)

c000013: Yeni bağlantı noktaları için CONTROL dosyaları yerine bildirim dosyaları kullanılır

Var olan birçok bağlantı noktası CONTROL dosyası söz dizimini kullanır; Bu söz dizimi bir süre desteklenecek olsa da, yeni bağlantı noktaları bunları kullanmamalıdır. Yeni eklenen tüm bağlantı noktalarının bildirim dosyalarını kullanması gerekir .

Bağlantı noktalarında önemli değişiklikler yapıldığında bildirim dosyalarına geçiş yapılmasını da öneririz; ancak bu gerekli değildir. Yararlı bulabilirsiniz vcpkg format-manifest .