W3C

 

On this page

How to raise issues in the i18n Tracker

The i18n WG uses tracker to track comments raised against the specs of other WGs. This page outlines how WG members raise those issues.

Members of the i18n Interest Group are encouraged to submit comments to www-international@w3.org. The i18n WG will then convert those comments to tracker issues as appropriate. If you are submitting comments to www-international, please submit one comment per email - otherwise the threads are likely to get hopelessly tangled.

Start here!

You may encounter a new issue while reviewing a spec or come across an issue already raised by someone else in an email thread or bugzilla and feel that the i18n WG should follow that thread. In either case, follow the steps below and click on the links to see detailed instructions.

  1. Is there a tracker product at http://www.w3.org/International/track/products for the document in question?
    If yes, go to step 2.
    Otherwise, create a product, then go to step 2.
  2. Create an issue.
  3. Once the i18n WG has reviewed the comments, notify the relevant Working Group.
  4. Monitor the email/bugzilla thread and contribute to the discussion.
  5. When the issue has been addressed, close the issue and inform the relevant WG that you have done so.

i18n WG shepherds are assigned to products to facilitate work on the issues. They bring issues to the i18n WG attention if action is needed to move them forward or close them. In particular, shepherds should regularly check that relevant WGs have been notified about issues raised, but you should check that the i18n WG reviews your new issues.

Create a product

  1. Click on the Add a new product link at the bottom of the list of products.

  2. Choose a name for the product that represents the document concisely (the short form of a document name used in it's URI is usually a good idea). Type the name in the Name field

  3. IMPORTANT! Always leave the mailing list selection set to default (public-i18n-core@w3.org).

Create an issue

  1. Go to http://www.w3.org/International/track/ and click on 'Create' under 'Issues' at the top right of the page.

  2. Write a short, succinct title. (Ignore the Nickname field in tracker.)

  3. Choose the product.

  4. Fill in Raised by

  5. If this is an issue you have identified (eg. via a review), follow these steps:

    1. Always start the description with information about the location of the text your comment refers to.  Do this by listing the section number and name, followed by a URI.  For example:

      6.2.1 Extended Metadata Block
      http://www.w3.org/TR/2010/WD-WOFF-20101116/#Metadata

      Try to always use dated versions of the spec and point to the section in that dated version. This makes it easier to see the original text later. Adding the URI takes a few moments longer, but it saves lots of time later for you and others reading the issue.

    2. Write your comment, in as succinct and well-organised a way as possible.  It is usually helpful to quote the text you are commenting on at the beginning of your comment. For example,

      "The text elements MAY be given a lang attribute."
      We feel that you should use xml:lang for this.
    3. Add " ⓟ" to the end of the title, to signify that this issue is pending review by the WG.

    4. (See an example.) Go to step 7.

  6. Otherwise (eg. this is a thread you have noticed and want the WG to track), follow these steps:

    1. Always start the description with a link to the first email in the email thread, if an email discussion, or to the bugzilla bug, if a bugzilla-based discussion.

      Thread: <link>, or

      Bugzilla: <link>

    2. Add the name of the person who created the thread or bug, eg.

      Raised by: Anne Other

    3. If there is no link to the appropriate section of the specification being discussed, you could add one. Make the link specific to the appropriate section, where possible, eg.

      About: <link to spec section>

    4. Now copy the content of the first email in the thread or the first entry in the bugzilla bug stream to the description field. This usually summarises the initial issue and makes it easier to remember what the issue is about.

    5. Add " ⓣ" to the end of the title, to signify that this issue is being tracked, rather than raised against a WG spec.

    6. (See an example.) Go to step 7.

  7. Click on Create.

Notify the relevant WG

  1. If the relevant WG wants you to use bugzilla:

    1. Create a bug. Log in using the email address of the i18n list where you want emails to be copied (usually www-international) (ask Richard Ishida for help with the password).

    2. IMPORTANT! Start the bugzilla summary field with "i18n-" and add the title of the tracker comment - leading to a summary such as "i18n-ISSUE-72: BOM as preferred encoding declaration". This is important, because it means that the tracker will track the emails that are sent to public-i18n-core, and it will not confuse this issue with issues of the other WG.

      Also remove the ⓟ from the title of the issue, since this is no longer pending review.

    3. Copy over the information in the tracker issue description to the bugzilla description, incorporating any changes that arise out of discussions with the i18n WG.

    4. Click on Save Changes. (See an example.)

    5. Edit the description field of the issue in the tracker, adding a link to the bugzilla bug at the top. (See an example.)

  2. If the relevant WG uses email for comments:

    1. Create an email and copy over the information in the tracker issue description to the body of the email, incorporating any changes that arise out of discussions with the i18n WG.
    2. IMPORTANT! Start the email subject field with "i18n-" and add the title of the tracker comment - leading to a summary such as "i18n-ISSUE-72: BOM as preferred encoding declaration". This is important, because it means that the tracker will track the emails that are sent to public-i18n-core, and it will not confuse this issue with issues of the other WG.

      Also remove the ⓟ from the title of the issue, since this is no longer pending review.

    3. Send the email to www-international@w3.org and to the WG that produced the specification. (Note that we are not sending to public-i18n-core.) If appropriate, the email could be sent to one of the other IG lists instead of or in addition to www-international.) (See an example.)


Copyright © 2013 W3C ® (MIT, ERCIM, Keio, Beihang) Usage policies apply.
Content last changed 2013-01-23 19:43 GMT.