KristianTrifork
commented
8 months ago Rules for Nuget Packaget
Naming
-
Contain prefix properly and clearly identify owner (eg. Trifork or Cheetah)
-
ID prefix more than 4 letters, and not a common word.
-
Separated by "." (eg. Cheetah.Kafka.Connector, Cheetah.Auth)
Versioning
-
Use: Semver (Major.Minor.Patch[-prerelease]) format
-
Publish package as pre-release if it non-stable or in preview
Authors
- Use field for organizations's "pretty name" (thinking project here)
Description
- Include short description
Project URL
- Link to associated project, repository or company website
README
- Add README markdown file that provide how to get started and what the package does
Release notes
- Include release notes with each update describing what changed were made
Package Strategy
-
Cheetah.Core: Containing logic for handling core features, not exposed. eg. How to handle token service.
-
Cheetah.Auth.Kafka: Package for making consumer and producer in Kafka, with authentication from OAuth2. Depends on Core.
-
Cheetah.Auth.OpenSearch: Package for making OpenSearch client, with authentication from OAuth2. Depends on Core.
-
Cheetah.Test.ComponentTest: Package for making component test. Depends on Kafka and OpenSearch.
I det skal man bruge enten WebAPI shared eller ComponentTest for at få connectors til OpenSearch og Kafka.
Kom med en strategi for hvilke pakker der skal være, så man bedre modulært kan hente de pakker man skal bruge, uden