Update on reported project file related issues (#46)

Qowaiv · Jul 29, 2024 · f7662e4 · f7662e4
1 parent eca0588
commit f7662e4
Show file tree

Hide file tree

Showing 6 changed files with 54 additions and 13 deletions.
diff --git a/props/common.props b/props/common.props
@@ -3,16 +3,20 @@
 
   <PropertyGroup>
     <Description>Qowaiv implements common, universal domain objects. These types form the base of your domain model.</Description>
-    <Authors>Ad van der Hoeven;Corniel Nobel;Erik Ammerlaan;Jack Kester;Jur Balledux;Marcel Strik;Mitchell Smit;Patrick Evers;Wilko Frieke</Authors>
+    <Authors>
+      Corniel Nobel;
+      Jack Kester;
+      Jur Balledux;
+      Marcel Strik;
+      Patrick Evers
+    </Authors>
     <Owners>Qowaiv community</Owners>
     <PackageTags>qowaiv domain model</PackageTags>
     <Company>Qowaiv community</Company>
     <Copyright>Copyright © Qowaiv community 2013-current</Copyright>
     <LangVersion>12.0</LangVersion>
     <IsPublishable>false</IsPublishable>
     <Nullable>enable</Nullable>
-    <!-- We ship package versions for obsolete target frameworks too -->
-    <CheckEolTargetFramework>false</CheckEolTargetFramework>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/props/package.props b/props/package.props
@@ -6,17 +6,23 @@
   <PropertyGroup Condition="'$(CompileConfig)' != 'DEBUG'">
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
   </PropertyGroup>
-
-  <PropertyGroup>
+
+  <PropertyGroup Label="Package info">
+    <IsPackable>true</IsPackable>
+    <EnablePackageValidation>true</EnablePackageValidation>
     <PackageIcon>package-icon.png</PackageIcon>
-    <PackageProjectUrl>http://www.github.com/Qowaiv/Qowaiv</PackageProjectUrl>
+    <PackageIconUrl>https://github.com/Qowaiv/qowaiv-domainmodel/blob/master/design/package-icon.png</PackageIconUrl>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
+    <PackageProjectUrl>http://www.github.com/Qowaiv/qowaiv-domainmodel</PackageProjectUrl>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
     <RepositoryType>git</RepositoryType>
-    <RepositoryUrl>https://github.com/Qowaiv/Qowaiv</RepositoryUrl>
+    <RepositoryUrl>https://github.com/Qowaiv/qowaiv-domainmodel</RepositoryUrl>
     <DefineConstants>CONTRACTS_FULL</DefineConstants>
+    <!-- We ship package versions for obsolete target frameworks too -->
+    <CheckEolTargetFramework>false</CheckEolTargetFramework>
   </PropertyGroup>
- 
-   <ItemGroup>
+
+  <ItemGroup>
     <!-- Shared assembly tags. -->
     <Compile Include="$(MSBuildThisFileDirectory)..\shared\ProductInfo.cs" Link="Properties\ProductInfo.cs" />
   </ItemGroup>
@@ -31,9 +37,7 @@
 
   <ItemGroup Label="Package files">
     <None Include="$(MSBuildThisFileDirectory)..\design\package-icon.png" Pack="true" PackagePath="" />
-    <!-- TODO: Include a README per package.
     <None Include="README.md" Pack="true" PackagePath="" />
-    -->
   </ItemGroup>
 
   <PropertyGroup Label="Signing">

diff --git a/src/Qowaiv.DomainModel.TestTools/Qowaiv.DomainModel.TestTools.csproj b/src/Qowaiv.DomainModel.TestTools/Qowaiv.DomainModel.TestTools.csproj
@@ -20,7 +20,6 @@ v0.1.0
 v0.0.1
 - Initial release
     </PackageReleaseNotes>
-    <EnablePackageValidation>true</EnablePackageValidation>
     <PackageValidationBaselineVersion>1.0.0</PackageValidationBaselineVersion>
   </PropertyGroup>
 

diff --git a/src/Qowaiv.DomainModel.TestTools/README.md b/src/Qowaiv.DomainModel.TestTools/README.md
@@ -0,0 +1,7 @@
+# Qowaiv..DomainModel.TestTools
+
+## Package
+This package contains helpers to make writing unit tests for Aggregates easier.
+
+## Further reading
+More info can be found at https://github.com/Qowaiv/qowaiv-domainmodel.
diff --git a/src/Qowaiv.DomainModel/Qowaiv.DomainModel.csproj b/src/Qowaiv.DomainModel/Qowaiv.DomainModel.csproj
@@ -56,7 +56,6 @@ v0.0.2
 v0.0.1
 - Initial release
     </PackageReleaseNotes>
-    <EnablePackageValidation>true</EnablePackageValidation>
     <PackageValidationBaselineVersion>1.0.0</PackageValidationBaselineVersion>
   </PropertyGroup>
 

diff --git a/src/Qowaiv.DomainModel/README.md b/src/Qowaiv.DomainModel/README.md
@@ -0,0 +1,28 @@
+# Qowaiv.DomainModel
+Qowaiv Domain Model is a library containing the (abstract) building blocks to
+set up a Domain-Driven application.
+
+## Event Sourcing
+Within Qowaiv Domain Model, the choice has been made to only support DDD via
+Event Sourcing. In short: Event Sourcing describes the state of an aggregate
+(root) by the (domain) events that occurred within the domain. Getting the
+current state of an aggregate can always be achieved by replaying these
+events. 
+
+## Always Valid
+The aggregate should always be valid according to the boundaries of its domain.
+There are multiple ways to achieve this, but within Qowaiv Domain Model this is
+guaranteed via an implicitly triggered validator.
+
+When a public method is called that would lead to a new aggregate state, the
+events describing the change are only added to the event buffer
+associated with the aggregate if the new state is valid according to the
+rules specified in the validator.
+
+## Aggregate
+An aggregate is a cluster of associated objects that we treat as a unit for the
+purpose of data changes. When implementing an aggregate there are several steps
+that have to be taken.
+
+## Further reading
+More info can be found at https://github.com/Qowaiv/qowaiv-domainmodel.