search

w3c / jlreq

Text Layout Requirements for Japanese
https://w3c.github.io/jlreq/
Other
101 stars 17 forks source link

[house-keeping] keep consistency of label usage over issues #250

Open himorin opened 3 years ago

himorin commented 3 years ago
r12a commented 3 years ago

I have applied some descriptions to the labels in the jlreq repo, so that their intended use is clearer. These labels are for use with issues that contain text in their first comment which will be sucked into the Japanese Gap Analysis document. With one exception (noted below) they should not be used for other issues.

These 3 are to ensure that gap analysis issue text ends up in the correct document and section in the GAP ANALYSIS document (only).

gap The first comment in this issue is read by the gap-analysis document. Issues without this label do not insert text into the gap analysis document.

doc:jlreq Used for gap analysis (only) to indicate target document. In the Japanese repo there is only one gap analysis document, but in several other language enablement repos there are multiple documents, so a label like this is essential. I don't want to change the mechanism for just one or two repos, so this label should continue to be used (for gap analysis issues only). doc:jlreq is NOT appropriate to refer to the jlreq requirements doc.

i:baselines_line_height_etc (and other beginning with i:) Relevant section in the LE Index. Must use for gap analysis issues. Also useful for others. Labels beginning with i: CAN be used with other issues than those containing gap-analysis doc text. They can be useful to help find all discussions on a particular topic.

There is another set of labels, also only for use with gap analysis issues:

p:advanced (and others beginning with p:) Used for gap analysis issues (only) to indicate priority.

@himorin could you please remove inappropriate uses of the doc:jlreq label. If you want a label to distinguish the JLReq requirement doc from others (such as the Simple Ruby doc), i suggest you create one called requirements, or jlreq or something similar. There is already a simple-ruby label.

Also, it is inappropriate to unite issues with the gap-analysis and gap labels, since the former do not contain text formatted for insertion into the gap analysis document, and the latter do.

While i'm doing this, i changed the description for the question label. This label is to be used for issues that seek answers to questions about how Japanese works, and they should all have a corresponding tracker issue in the i18n-activity repo. That, in turn, means that they'll be picked up by our summary page at https://w3c.github.io/i18n-activity/textlayout/

himorin commented 3 years ago

Ahh,, sorry that I've had wrong memory on usage of doc:jlreq. I'll check with guideline for gap analysis and other label handlings. For gap-analysis and gap, my line was not appropriate for work item to be exposed (too-less words), and original intention was to check whether ones with gap-analysis are covered by existing gap issues and add new (or convert into) format of gap if in need.