ICU-23056 Update "scrub issues" miscellaneous.md

This describes the new script for finding issues marked "done" but that that haven't had comments updated in test code.

Author: Craig Cornelius

docs/processes/release/tasks/miscellaneous.md

@@ -139,11 +139,92 @@ a model.
 
 ## Scrub closed issues in code
 
+ICU and CLDR issues are tracked with the [Unicode JIRA tool](https://unicode-org.atlassian.net/jira/dashboards/last-visited). Each open issue should be indicated in code with either "TODO" or "knownIssue" as a comment that includes the JIRA identifier.
+
+Sometimes an issue has been marked as "done" without updating the "TODO" or "knownIssue" item in the code or test routines. This step is used to synchronize the issue database and the code.
+
+The idea is simple:
+
 (1) Search for "TODO(12345)" to detect TODO items for closed issues.
 
 (2) Do the same for logKnownIssue. (the data related logKnownIssues are often
 addressed during CLDR data integration)
 
-If the TODO or logKnownIssue references a closed issue, if the problem is fixed,
-remove the TODO/logKnownIssue, or if the problem is not fixed, open a new issue
+(3) For each TODO or logKnownIssue that is marked as "done", check the status:
+* If the problem is fixed,remove the TODO/logKnownIssue.
+* If the problem is not fixed, either reopen the issue or create a new issue
 and update the reference in the code.
+* Communicate problems with the Unicode tech team.
+
+> [!NOTE]
+> New in ICU78: Finding issues is automated with a python script in
+icu/tools/scripts/scrub_issues. Here's how:
+
+1. Install the python jira module, e.g., `pip install jira`. See [pypi.org.project/jira](https://pypi.org/project/jira/).
+2. Get the latest version of ICU code in local directory, e.g., ~/newICU.
+3. Execute the script from the scrub_issues directory with the ICU code path:
+```
+# In the new ICU directory
+cd icu/tools/scripts/scrub_issues/scrub_issues.py
+python scrub_issues.py  --icu_base ~/newICU/icu |& tee new_scrub_results.txt
+```
+4. Examine each line of the "Closed ids" section of the output file:
+ * Try removing the code that prevents tests from failing in the lines for each of the "knownIssue" and "TODO" items.
+ * If a modified test passes, update the code in the Github repository.
+ * After merging changes, synch with the repository. Then rerun the python script to verify that the status is updated.
+
+By default, the script reports all instances of each TODO or knownIssue by file and line number in that file.
+
+### Possible closed issues: update the comments
+```
+INFO:scrub issues:----------------------------------------------------------------
+INFO:scrub issues:2 Closed ids: ['ICU-23185', 'CLDR-18905']
+INFO:scrub issues:       ['CLDR-18905', 'logKnownIssue', '/icu/icu4j/main/common_tests/src/test/java/com/ibm/icu/dev/test/format/MeasureUnitTest.java', 529]
+INFO:scrub issues:       ['CLDR-18905', 'logKnownIssue', '/icu/icu4c/source/test/intltest/measfmttest.cpp', 5529]
+INFO:scrub issues:       ['CLDR-18905', 'logKnownIssue', '/icu/icu4c/source/test/intltest/measfmttest.cpp', 5956]
+INFO:scrub issues:       ['ICU-23185', 'logKnownIssue', '/icu/icu4j/main/core/src/test/java/com/ibm/icu/dev/test/format/DateIntervalFormatTest.java', 895]
+INFO:scrub issues:       ['ICU-23185', 'logKnownIssue', '/icu/icu4j/main/core/src/test/java/com/ibm/icu/dev/test/format/DateIntervalFormatTest.java', 900]
+INFO:scrub issues:       ['ICU-23185', 'logKnownIssue', '/icu/icu4c/source/test/intltest/dtifmtts.cpp', 1255]
+INFO:scrub issues:       ['ICU-23185', 'logKnownIssue', '/icu/icu4c/source/test/intltest/dtifmtts.cpp', 1262]
+```
+
+### Non-standard identifiers. Issues not in JIRA
+
+This script also finds commented lines that are not named with either "ICU-" or "CLDR-" plus a number. Often these are very old issues that may have been resolved without updating the code.
+
+Sometimes just an indentifier that is simple a number is found. In these cases, the script checks if there is a JIRA issue with either prefix and that number. 
+Consider updating the test code with the full identifier. In that case "REPLACEMENT" is shown.
+
+Examples:
+
+```
+INFO:root:Base Directory: /usr/local/google/home/ccornelius/ICU78-new/icu
+INFO:scrub issues:----------------------------------------------------------------
+INFO:scrub issues:       ['knownIssue', 'logKnownIssue', '/icu/icu4j/main/core/src/test/java/com/ibm/icu/dev/test/format/PersonNameConsistencyTest.java', 89]
+INFO:scrub issues:       ['knownIssue', 'logKnownIssue', '/icu/icu4j/main/core/src/test/java/com/ibm/icu/dev/test/format/PersonNameConsistencyTest.java', 99]
+INFO:scrub issues:REPLACEMENT 22099 --> ICU-22099 (Accepted)
+INFO:scrub issues:       ['22099', 'logKnownIssue', '/icu/icu4j/main/core/src/test/java/com/ibm/icu/dev/test/number/ExhaustiveNumberTest.java', 61]
+INFO:scrub issues:       ['a/b/c', 'logKnownIssue', '/icu/icu4j/main/core/src/test/java/com/ibm/icu/dev/test/TestUnicodeKnownIssues.java', 25]
+INFO:scrub issues:       ['a/b/c', 'logKnownIssue', '/icu/icu4j/main/core/src/test/java/com/ibm/icu/dev/test/TestUnicodeKnownIssues.java', 37]
+...
+INFO:scrub issues:       ['String ticket', 'logKnownIssue', '/icu/icu4j/main/framework/src/test/java/com/ibm/icu/dev/test/TestFmwk.java', 198]
+WARNING:scrub issues:Not in JIRA : "Tom" (1 instances)
+INFO:scrub issues:       ['Tom', 'TODO', '/icu/icu4j/main/core/src/main/java/com/ibm/icu/impl/SimpleFilteredSentenceBreakIterator.java', 32]
+WARNING:scrub issues:Not in JIRA : "a/b/c" (7 instances)
+INFO:scrub issues:       ['a/b/c', 'logKnownIssue', '/icu/icu4j/main/core/src/test/java/com/ibm/icu/dev/test/TestUnicodeKnownIssues.java', 25]
+INFO:scrub issues:       ['a/b/c', 'logKnownIssue', '/icu/icu4j/main/core/src/test/java/com/ibm/icu/dev/test/TestUnicodeKnownIssues.java', 37]
+INFO:scrub issues:       ['a/b/c', 'logKnownIssue', '/icu/icu4j/main/core/src/test/java/com/ibm/icu/dev/test/TestUnicodeKnownIssues.java', 54]
+...
+```
+
+Finally, the script reports all issues that have JIRA entries with status 'Accepted' or 'Design', showing the instances in code:
+
+```
+INFO:scrub issues:Unresolved IDS: 57 still not "Done" in Jira
+...
+INFO:scrub issues:id: ['13034', 'Accepted']
+INFO:scrub issues:       ['13034', 'TODO', '/icu/icu4c/source/test/intltest/numfmtst.cpp', 8613]
+INFO:scrub issues:       ['13034', 'TODO', '/icu/icu4c/source/i18n/number_padding.cpp', 32]
+```
+
+It is recommended to review such unresolved issues periodically.