Kitaplık kılavuzu
Bu kılavuz, geliştiricilerin yüksek kaliteli .NET kitaplıkları oluşturması için öneriler sağlar. Bu belge, .NET kitaplığı oluştururken nasıl ve neden olduğu konusuna değil, ne ve nedenlerine odaklanır.
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 birlikte bulunan ve birçok kitaplıkla oluşturulmuş uygulamalarda çalışan iyi .NET kitaplıkları.
- Gelişecek şekilde tasarlandı - .NET kitaplıkları zaman içinde geliştirilmeli ve geliştirilmeli ve 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ı, en iyi güvenlik uygulamalarını kullanarak NuGet yayımlayarak geliştiricilerin güvenine sahiptir.
Ö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 uymalısınız. Örneğin:
✔️ KITAPLıĞınızı bir NuGet paketi kullanarak DAĞıTIN.
Öte yandan, Önerileri genel olarak dikkate almanız gerekir, ancak kuralda geçerli özel durumlar vardır ve rehberliğe uymadığınız için kendinizi kötü hissetmemelisiniz:
✔️ NuGet paketinizi sürüm olarak SemVer 2.0.0 kullanmayı DÜŞÜNÜN.
Önerilerden genellikle iyi bir fikir olmayan şeylerden bahsetmekten kaçının, ancak kuralın çiğnenmesi bazen mantıklıdır:
❌TAM sürüm gerektiren NuGet paket başvurularından KAÇıNıN.
Ve son olarak, Öneriler neredeyse hiçbir zaman yapmanız gereken bir şeyi belirtmeyin:
❌ Kitaplığınızın tanımlayıcı adlı ve tanımlayıcı olmayan sürümlerini YAYıMLAMAYIN. Örneğin Contoso.Api ve Contoso.Api.StrongNamed.