diff options
author | Chris Rebert <code@rebertia.com> | 2014-10-11 04:16:39 +0400 |
---|---|---|
committer | Chris Rebert <code@rebertia.com> | 2014-10-11 04:16:39 +0400 |
commit | 688bc9de062f83c39c43ca45b2dea8951991b8d5 (patch) | |
tree | 3f7925020113bb6bef131321a08394d7b86bffc7 | |
parent | 3222a2f744db2d4f837378bce5c9e89bf0ce0609 (diff) |
add links to explanatory docs in posted comments
-rw-r--r-- | src/main/scala/com/getbootstrap/rorschach/auditing/BaseAndHeadBranchesAuditor.scala | 4 | ||||
-rw-r--r-- | src/main/scala/com/getbootstrap/rorschach/auditing/ModifiedFilesAuditor.scala | 6 |
2 files changed, 5 insertions, 5 deletions
diff --git a/src/main/scala/com/getbootstrap/rorschach/auditing/BaseAndHeadBranchesAuditor.scala b/src/main/scala/com/getbootstrap/rorschach/auditing/BaseAndHeadBranchesAuditor.scala index f412e78..6480ac6 100644 --- a/src/main/scala/com/getbootstrap/rorschach/auditing/BaseAndHeadBranchesAuditor.scala +++ b/src/main/scala/com/getbootstrap/rorschach/auditing/BaseAndHeadBranchesAuditor.scala @@ -10,14 +10,14 @@ object BaseAndHeadBranchesAuditor { def auditThatNotAgainstGhPages(baseBranch: String): Option[String] = { baseBranch match { - case "gh-pages" => Some("Normal pull requests should never be against the `gh-pages` branch.") + case "gh-pages" => Some("[Normal pull requests should never be against the `gh-pages` branch.](https://github.com/cvrebert/rorschach/blob/master/docs/against-gh-pages.md)") case _ => None } } def auditThatNotMergingGhPagesIntoMaster(baseBranch: String, headBranch: String): Option[String] = { (headBranch, baseBranch) match { - case ("gh-pages", "master") => Some("Normally, the `gh-pages` branch should never be merged into `master` branch.") + case ("gh-pages", "master") => Some("[Normally, the `gh-pages` branch should never be merged into `master` branch.](https://github.com/cvrebert/rorschach/blob/master/docs/gh-pages-into-master.md)") case _ => None } } diff --git a/src/main/scala/com/getbootstrap/rorschach/auditing/ModifiedFilesAuditor.scala b/src/main/scala/com/getbootstrap/rorschach/auditing/ModifiedFilesAuditor.scala index 67f3f3c..3a4bbcc 100644 --- a/src/main/scala/com/getbootstrap/rorschach/auditing/ModifiedFilesAuditor.scala +++ b/src/main/scala/com/getbootstrap/rorschach/auditing/ModifiedFilesAuditor.scala @@ -22,7 +22,7 @@ object ModifiedFilesAuditor { val cssModified = filepaths.exists{ _.isDistCss } val lessModified = filepaths.exists{ _.isSourceLess } if (cssModified && !lessModified) { - Some("Changes must be made to the original Less source code file(s), not just the compiled CSS file(s).") + Some("[Changes must be made to the original Less source code file(s), not just the compiled CSS file(s).](https://github.com/cvrebert/rorschach/blob/master/docs/css.md)") } else { None @@ -36,7 +36,7 @@ object ModifiedFilesAuditor { val distJsModified = filepaths.exists{ _.isDistJs } val sourceJsModified = filepaths.exists{ _.isSourceJs } if (distJsModified && !sourceJsModified) { - Some("Changes must be made to the original JS source code file(s), not just the generated concatenated JS file(s).") + Some("[Changes must be made to the original JS source code file(s), not just the generated concatenated JS file(s).](https://github.com/cvrebert/rorschach/blob/master/docs/js.md)") } else { None @@ -45,7 +45,7 @@ object ModifiedFilesAuditor { private def auditCname(filepaths: Set[String]): Option[String] = { if (filepaths.contains("CNAME")) { - Some("The `CNAME` file should never be modified (except in extremely unlikely circumstances).") + Some("[The `CNAME` file should never be modified.](https://github.com/cvrebert/rorschach/blob/master/docs/cname.md)") } else { None |