Some tidying up

dockstore · Aug 25, 2023 · 80a9f56 · 80a9f56
1 parent 3943173
commit 80a9f56
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/jira_automation/README.md b/jira_automation/README.md
@@ -7,7 +7,7 @@ a configuration issue again, it could be useful in the future.
 2. io.dockstore.jira.MilestoneChecker - generates GitHub and JQL queries to find mismatches in the JIRA fix version and GitHub milestone. The JIRA fix version is
 a multi-value field; the GitHub milestone is a single-value field, so Unito doesn't sync them. We have to remember to manually
 keep them in sync; this program identifies cases we've missed.
-3. SprintStart - an barely started work in progress to automatically generate review tickets at the beginning of a sprint, which
+3. SprintStart - a barely started work in progress to automatically generate review tickets at the beginning of a sprint, which
 is currently a manual and tedious process.
 
 # Auth

diff --git a/jira_automation/src/main/java/io/dockstore/jira/MilestoneChecker.java b/jira_automation/src/main/java/io/dockstore/jira/MilestoneChecker.java
@@ -11,7 +11,9 @@
 
 /**
  * Generates a GitHub url with all dockstore issues whose milestone does not match the fix version
- * in JIRA.
+ * in JIRA. Works by looking at all open GitHub issues, then reading the info Unito appends to the
+ * description in GitHub, which includes the fix version. It compares the fix version in JIRA with
+ * the milestone of the GitHub issue.
  */
 public final class MilestoneChecker {