Skip to content

Commit 4728e5a

Browse files
committed
ICU-23056 Update documentation on BRS "Scrub issues"
See #3712
1 parent ca3c5a7 commit 4728e5a

File tree

1 file changed

+32
-7
lines changed

1 file changed

+32
-7
lines changed

docs/processes/release/tasks/miscellaneous.md

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -139,9 +139,18 @@ a model.
139139
140140
## Scrub closed issues in code
141141
142-
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.
142+
ICU and CLDR issues are tracked with the [Unicode JIRA
143+
tool](https://unicode-org.atlassian.net/jira/dashboards/last-visited). Each open
144+
issue should be indicated in code with either "TODO" or "knownIssue" as a
145+
comment that includes the JIRA identifier.
143146
144-
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.
147+
A "TODO" or "knownIssue" usually prevents a test from executing, often with
148+
specific conditions. Instead, the output will include a message indicating that
149+
the issue is present but that it does not prevent the test suite from passing.
150+
151+
Note that sometimes an issue has been marked as "done" without updating the
152+
"TODO" or "knownIssue" item in the code or test routines. This step is used to
153+
synchronize the issue database and the code.
145154
146155
The idea is simple:
147156
@@ -150,11 +159,27 @@ The idea is simple:
150159
(2) Do the same for logKnownIssue. (the data related logKnownIssues are often
151160
addressed during CLDR data integration)
152161
153-
(3) For each TODO or logKnownIssue that is marked as "done", check the status:
154-
* If the problem is fixed,remove the TODO/logKnownIssue.
155-
* If the problem is not fixed, either reopen the issue or create a new issue
156-
and update the reference in the code.
157-
* Communicate problems with the Unicode tech team.
162+
(3) For each TODO or logKnownIssue that is marked as "done", check the status in
163+
JIRA. Check if the problem is actually fixed by removing the TODO/logKnownIssue
164+
protection from the code so the test will be executed.
165+
166+
(4) Verify that the test now passes. First run local tests, i.e., in icu4c or
167+
icu4j.
168+
169+
If any test does not pass, either reopen the issue or create a new issue and
170+
update the reference in the code. Then communicate the problems with the Unicode
171+
tech team.
172+
173+
(5) If all tests have passed so far, run the exhaustive tests with the update.
174+
[See Exhaustive Tests](https://unicode-org.github.io/icu/userguide/dev/ci.html#:~:text=Exhaustive%20tests%20run%20tests%20on,and%20click%20'Run%20workflow') for details.
175+
176+
If any test does not pass, the JIRA status is incorrect. Raise this problem with
177+
the Unicode tech team as noted above.
178+
179+
If the exhaustive tests all pass, the TODO or knownIssue can be
180+
scrubbed. Createa pull request and request a review. Submit when approved and
181+
all conditions pass.
182+
158183
159184
> [!NOTE]
160185
> New in ICU78: Finding issues is automated with a python script in

0 commit comments

Comments
 (0)