ICU-20438 Further updating readme and instructions for commit-checker.

Author: sffc

tools/commit-checker/README.md

@@ -13,28 +13,34 @@ Author: Shane Carr
 
 Install `pipenv` globally:
 
-	$ sudo pip3 install pipenv
+    $ sudo pip3 install pipenv
 
 Install this project's dependencies locally:
 
-	$ pipenv install
+    $ pipenv install
 
 Optional: save your Jira credentials in a `.env` file in this directory:
 
-	JIRA_USERNAME=hello
-	JIRA_PASSWORD=world
+    JIRA_USERNAME=hello
+    JIRA_PASSWORD=world
 
 This is required if you want to process sensitive tickets.
 
 ## Usage
 
 Make sure you have updated your repository:
 
-	$ git pull upstream master
-	$ git fetch --tags upstream
+    $ git checkout master
+    $ git pull upstream master
+    $ git fetch --tags upstream
 
-Run the tool and save the result into REPORT.md:
+Sanity check: ensure that the "latest" tag is correct (points to the latest release).  You may need to force-fetch the tags.
 
-	$ pipenv run python3 check.py --jira-query "project=ICU AND fixVersion=63.1" > REPORT.md
+    $ git show latest
+    # should show a commit with both "latest" and the previous version number
 
-Open a pull request so others can view the report easilly.
+Run the tool and save the result into REPORT.md; set fixVersion to the *upcoming* ICU version:
+
+    $ pipenv run python3 check.py --jira-query "project=ICU AND fixVersion=64.1" > REPORT.md
+
+Create a branch and open a pull request so others can view the report easily.

tools/commit-checker/check.py

@@ -52,8 +52,8 @@ class CommitWanted(Enum):
 )
 flag_parser.add_argument(
     "--jira-query",
-    help = "JQL query to match with tickets.",
-    default = "project=ICU AND fixVersion=63.1"
+    help = "JQL query load tickets; this should match tickets expected to correspond to the commits being checked. Example: 'project=ICU and fixVersion=63.1'; set fixVersion to the upcoming version.",
+    required = True
 )