Integrate code review remarks

GitTools · May 7, 2024 · 943fc4c · 943fc4c
1 parent bcaa174
commit 943fc4c
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/GitVersion.Core/VersionCalculation/TrunkBased/NonTrunk/FirstCommitOnRelease.cs b/src/GitVersion.Core/VersionCalculation/TrunkBased/NonTrunk/FirstCommitOnRelease.cs
@@ -2,6 +2,11 @@
 
 namespace GitVersion.VersionCalculation.TrunkBased.NonTrunk;
 
+/// <summary>
+/// This incrementer identifies the first commit on a branch marked with IsReleaseBranch true and appends the version number for
+/// instance 1.0.0 (extracted from the branch name) as an alternative semantic version to the context. This information will be
+/// used later to bump the version number to a higher value if necessary.
+/// </summary>
 internal sealed class FirstCommitOnRelease : ITrunkBasedIncrementer
 {
     // B  57 minutes ago  (HEAD -> release/1.0.0)