Keeping tracker issues up to date

From Internationalization
Jump to: navigation, search

These steps should be followed regularly to ensure that WG issues with the i18n-tracker label have an equivalent and correctly formed tracker issue in the i18n-activity repository.

A key purpose of this triage is to ensure that items are tracked either by the Review Tracker page, or by the Language Enablement Tracker page. Correct labelling is also important to maintain links from the Language Enablement Index.

We'll use here the following hyphenated terms:

  1. WG-issue: the issue in the repo of the non-i18n-WG
  2. lreq-issue: an issue in the repo of a layout requirements group, such as alreq, jlreq, mlreq, etc.
  3. tracker-issue: an issue in the i18n-activity repo, which i18n uses for tracking

These steps describe how to deal with two situations:

  1. Handling WG-issues with a new i18n-tracker label comes into play when someone adds an i18n-tracker label to a WG-issue. It is important to track that issue, and set up the right labels.
  2. Add appropriate labels to the tracker issue is applied when someone applies a Question label to an issue in a repo owned by a layout requirements (lreq) group.

Note that these instructions don't cover situations where a person reviewing a spec creates a provisional issue in the i18n-activity repo, nor when they convert that to a tracker issue while raising the comment as a WG-issue. Instructions for that are given in the document How to review specs and raise issues.


Handling WG-issues with a new i18n-tracker label

Tooling should automatically create tracker issues in the i18n-activity repo when someone applies an i18n-tracker label to a WG-issue. However, manual intervention is needed to apply all the necessary labels.

Follow these steps:

[1] Check the WG-issue for *lreq labels

If the WG-issue should be brought to the attention of any lreq groups, add the appropriate labels.

The labels may need to be created, since they are only added to a repo as and when needed.

The labels currently include the following: afrlreq, alreq, clreq, elreq, eurlreq, hlreq, ilreq, jlreq, mlreq, sealreq, tlreq.


[2] Add appropriate labels to the tracker issue

The tooling should automatically add a pending label and a tracker label, and may add a label to identify the spec.

  1. if one has not been automatically added, add an s:... label for the document/spec referred to. Labels begin with "s:", followed by the short name for the spec. Note, however, that WhatWG html issues are labelled using the html label. These labels have a light teal colour. (Ask r12a if you need a new label.)
  2. if the WG-issue is specifically asking for i18n to advise/comment, add the advice-requested label
  3. if you think this is an important issue which the i18n WG should consider sooner rather than later, add the needs-attention label
  4. Is there an i18n-*lreq label in the WG-issue?
    1. the tooling should have automatically added a spec-type-issue label (dark green background). If not, add one.
    2. if this is a WG-issue that constitutes a request for script/language expert advice, add the type-info-request label (red background)
    3. add the equivalent ...lreq label to the tracker-issue (eg. a WG issue with i18n-jlreq label would get a jlreq label in the tracker repo).
    4. Also add one or more i:... label(s) to indicate a relevant index category (eg. line-break). These labels correspond to the sections in the Language Enablement Index, and are used by that document and the issue tracker to filter issues.
  5. Remove the pending label.



Handling lreq-issues with a question label

Tooling doesn't yet create new tracker issues for these issues. When a question label is added to an issue in an lreq repository, a tracker issue should be created in the i18n-activity repo, and labels attached.

Go to https://github.com/w3c/i18n-activity/issues/new/choose and select "Create a tracker for an lreq question". Follow the instructions in the template.




Former manual process

This is the process on which the new tooling approach was based.

[1] Check the digests

These arrive in your mailbox, but you can also find them at

  1. https://lists.w3.org/Archives/Public/public-i18n-core/ (weekly) eg. Weekly github digest (Review comments) Lists changes to issues in other WG repos.
  2. https://lists.w3.org/Archives/Public/www-international/ (daily) eg. Daily github digest (I18n repos) Lists changes to issues in our repos, including lreq repos.

[2] What issues need to be tracked?

  1. Any issue in another WG’s repo that has received a new ‘i18n-tracker’ label.
  2. Any issues in lreq repositories that has been given the label ‘question’.

You shouldn’t need to report comments raised by the i18n WG, since those should be discussed by the group and labelled appropriately as part of the review process.

No need to raise tracker-issues for editorial comments in lreq repos.

[3] Add i18n-?lreq labels to the other WG repo

This is only relevant to WG-issues – it’s not relevant to lreq-issues.

If a WG-issue is likely to be of interest to a particular lreq group, make sure that there is an appropriate i18n-?lreq label on the WG-issue.

An issue may be relevant to an lreq group, but not particularly of interest to them (eg. the editorial discussion about adding an example for bdo to html). Those cases probably don't need one of these labels.


[4] Raise new i18n tracker-issues

When you find something that needs to be tracked, do the following:

  1. create a new issue in the i18n-tracker repo.
  2. copy the title of the WG issue in question to the title field of the new tracker issue.
  3. remove all text in the Write area of the tracker issue down to, but not including, "**This is a tracker issue..."
  4. paste the url for the WG issue in place of the text "link_to_issue_raised" - DO NOT remove the § sign
  5. Summarise the gist of the question or comment at the top of the box you are typing into, preferably in no more than 2 sentences.

[5] Apply appropriate labels

  1. Is this an lreq-issue with a question label?
    1. add the type-info-request label (red background).
    2. Then add an ...lreq label for the appropriate layout group(s). These labels have a violet colour, eg. alreq. There should be related labels on the original issue if it was raised in a WG issue list.
    3. Add one or more i:... label(s) to indicate a relevant typographic feature (eg. line-break). Labels begin with i: followed by a language enablement category related to the Language Enablement Index.
  2. Is this is tracking a WG-issue?
    1. add the tracker label.
    2. add an s:... label for the document/spec referred to. Labels begin with s:, followed by the short name for the spec. Note, however, that WhatWG html issues are labelled using the html label. These labels have a light teal colour. (Ask r12a if you need a new label.)
    3. if the WG-issue is specifically asking for i18n to advise/comment, add the advice-requested label
    4. Is there an i18n-*lreq label in the WG repo?
      1. add the spec-type-issue label (dark green background)
      2. if this is a WG-issue that constitutes a request for script/language expert advice, add the type-info-request label (red background)
      3. add the equivalent ...lreq label to the tracker-issue (eg. a WG issue with i18n-jlreq label would get a jlreq label in the tracker repo).
      4. Also add one or more i:... label(s) to indicate a relevant index category (eg. line-break).

[6] Make a note of closed issues

For issues that have been closed by a WG or lreq group, add the label Close? to the issue in the tracker repo. This signals that we should check whether to close the tracker issue.