More comments added

vercel · Jan 6, 2017 · f141fb2 · f141fb2
1 parent 8e75b80
commit f141fb2
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 0 deletions.
diff --git a/lib/changelog.js b/lib/changelog.js
@@ -52,6 +52,7 @@ module.exports = async (types, commits, changeTypes) => {
     text += '\n'
     text += '### Credits \n\n'
 
+    // GitHub links usernames if prefixed with @
     for (const credit of credits) {
       text += `@${credit}`
     }

diff --git a/lib/connect.js b/lib/connect.js
@@ -52,6 +52,8 @@ const validateToken = async token => new Promise(resolve => {
     token
   })
 
+  // See if the token works by getting
+  // the data for our company's account
   github.users.getForUser({
     username: 'zeit'
   }, err => {

diff --git a/lib/pick-commit.js b/lib/pick-commit.js
@@ -14,6 +14,8 @@ module.exports = async (hash, all, changeTypes) => {
     hash = title.ref
 
     const rawHash = hash.split('#')[1]
+
+    // Retrieve users that have collaborated on a change
     const collaborators = await getCredits(rawHash)
 
     if (collaborators) {