Style: update code comments

hugo-fixit · Oct 30, 2024 · 5e98c78 · 5e98c78
1 parent 1909ab8
commit 5e98c78
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/changelog/setup.cjs b/changelog/setup.cjs
@@ -19,8 +19,14 @@ module.exports = function (Handlebars) {
    * @example {{githubUser "Cell"}} => "Lruihao"
    */
   Handlebars.registerHelper('githubUser', function (context, { hash: { linked = false }}) {
+    /**
+     * Map Commit names to GitHub usernames
+     * if your commit name is not same as your GitHub username, add an entry here.
+     */
     const map = {
+      // Author
       'Cell': "Lruihao",
+      // Collaborators, Contributors
     }
     const username = map[context] || context
     if (linked) {