Add some comments

microsoft · Apr 13, 2021 · 23dbb46 · 23dbb46
1 parent 22ba0b6
commit 23dbb46
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/changefile/promptForChange.ts b/src/changefile/promptForChange.ts
@@ -24,6 +24,10 @@ export async function promptForChange(options: BeachballOptions) {
   const packageInfos = getPackageInfos(cwd);
   const packageGroups = getPackageGroups(packageInfos, options.path, options.groups);
 
+  // Check recent commit messages for structured conventional
+  // commits. If present, and --useConventionalCommits is set, fetch
+  // change type and description from the first available commit
+  // message.
   const fromConventionalCommits =
     (options.useConventionalCommits &&
       recentMessages.map(parseConventionalCommit).filter(<T>(obj: T | undefined): obj is T => !!obj)) ||
@@ -71,6 +75,7 @@ export async function promptForChange(options: BeachballOptions) {
       },
     };
 
+    // Only include structured commit messages that map to an allowed change type.
     const allowedConventionalCommit = fromConventionalCommits.find((c) => !disallowedChangeTypes?.includes(c.type));
     const showChangeTypePrompt = !options.type && !allowedConventionalCommit && changeTypePrompt.choices!.length > 1;