Kitaplık kılavuzu

Bu kılavuz, geliştiricilerin yüksek kaliteli .NET kitaplıkları oluşturmasına yönelik öneriler sağlar. Bu belge, bir .NET kitaplığı ne ve neden oluşturulduğuna odaklanır, nasıl yapılacağına değil.

Yüksek kaliteli .NET kitaplıklarının özellikleri:

• Kapsayıcı - İyi .NET kitaplıkları birçok platformu, programlama dilini ve uygulamayı desteklemeye çalışır.
• Kararlı - .NET ekosisteminde uyum içinde çalışan ve birçok kitaplıkla oluşturulmuş uygulamalarda işlev gösteren iyi .NET kitaplıkları.
• Gelişecek şekilde tasarlandı - .NET kitaplıkları zaman içinde geliştirilmeli ve evrimleşmeli, bu sırada mevcut kullanıcıları desteklemelidir.
• Hata ayıklanabilir - .NET kitaplıkları, kullanıcılar için harika bir hata ayıklama deneyimi oluşturmak için en son araçları kullanmalıdır.
• Güvenilir - .NET kitaplıkları, güvenlikle ilgili en iyi yöntemleri kullanarak NuGet'e yayımlayarak geliştiricilerin güvenine sahiptir.

Başlayın

Öneri türleri

Her makalede dört tür öneri sunulur: Do, Consider, Avoid ve Do not. Öneri türü, ne kadar güçlü bir şekilde izlenmesi gerektiğini gösterir.

Neredeyse her zaman bir Do önerisine uymanız gerekir. Örneğin:

✔️ DO, kitaplığınızı nuget paketi kullanarak dağıtır.

Öte yandan, Tavsiye önerilerine genellikle uyulması gerekir, ancak kurala uymamanın meşru istisnaları vardır ve bu tavsiyelere uymadığınızda kendinizi kötü hissetmemelisiniz.

✔️ NuGet paketinizi sürüm olarak SemVer 2.0.0 kullanmayı düşünün.

Genel olarak iyi bir fikir olmayan şeylerden bahseden önerilerden kaçının, ancak bazen kuralı çiğnemek mantıklı olabilir.

❌ Tam sürüm gerektiren NuGet paket başvurularından KAÇıNıN.

Ve son olarak, Yapılmaması gereken öneriler, neredeyse hiçbir zaman yapmamanız gereken bir şeyi belirtir:

❌ Kitaplığınızın güçlü adlandırılmış ve güçlü adlandırılmamış sürümlerini YAYINLAMAYIN. Örneğin, Contoso.Api ve Contoso.Api.StrongNamed.

İleri