-
Notifications
You must be signed in to change notification settings - Fork 41
/
Copy pathissue-metadata.html
231 lines (222 loc) · 9.64 KB
/
issue-metadata.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>Labels and Other Metadata for Issues and Pull Requests</title>
<link rel="stylesheet" href="css/wgio.css">
<link rel="icon" type="image/x-icon" href="//labs.w3.org/favicon.ico">
<style>
dl.labels dt {
font-weight: bold;
line-height: 1.5em;
}
dl.labels dd {
margin-top: 1em;
}
dl.labels dt a {
padding: 0.7ex;
border-radius: 0.7ex;
text-decoration: none;
color: black;
}
</style>
</head>
<body>
<header>
<h1>Labels and Other Metadata for Issues and Pull Requests</h1>
</header>
<nav>
<a href="/">Home</a>
•
<a href="https://github.com/w3c/">Repositories</a>
•
<a href="https://help.github.com/">GitHub Help</a>
</nav>
<main>
<p>
This page describes how to use GitHub <a href="#labels">labels</a>, <a href="#milestones">milestones</a>, and <a href="#projects">projects</a> in a uniform way across W3C specifications.
</p>
<section id='labels'>
<h2>Labels</h2>
<a href="https://help.github.com/articles/creating-and-editing-labels-for-issues-and-pull-requests/">Labels</a> describe the kind of issue or specific work that's needed to advance an issue.
<section id='horizontal-reviews'>
<h3>Horizontal labels</h3>
<p>
Those labels are there to facilitate horizontal reviews.
</p>
<dl>
<dt class='security'>security</span></dt>
<dd>Affects the <a href='https://www.w3.org/TR/security-privacy-questionnaire/'>degree of resistance</a> to, or protection from, harm of Web technologies.</dd>
<dt class='privacy'>privacy</dt>
<dd>
<p>
Affects the collection, <a href='https://w3c.github.io/fingerprinting-guidance/'>processing</a> and <a href='https://www.w3.org/TR/security-privacy-questionnaire/'>publication of personal data</a> in Web technologies.
</p>
</dd>
<dt class='a11y'>Accessibility</dt>
<dd>
<p>Affects the design of Web technologies for people with disabilities.</p>
</dd>
<dt class='i18n'>Internationalization</dt>
<dd>
<p>Affects the <a href='https://www.w3.org/International/review-request'>adaptation of Web technologies to different languages or regional differences</a>.</p>
</dd>
<dt>architecture</dt>
<dd>Affects the <a href='https://w3ctag.github.io/design-principles/'>underlying principles</a> that should be adhered to by all Web technologies.</dd>
<dt>performance</dt>
<dd>Affects the download and display speed of Web technologies.</dd>
<dt>device independence</dt>
<dd>Affects the ability of Web technologies to function on a wide variety of devices.</dd>
</dl>
</section>
<section id='testing'>
<h3>Testing and Implementations</h3>
<p>Those labels are meant to track testing and implementation status.</p>
<dl>
<dt>needs tests</dt>
<dd>More tests will be needed in this area to exit the Candidate Recommendation state.</dd>
<dt>needs implementation</dt>
<dd>More implementation experience is needed in this area.</dd>
<dt>test:missing-coverage</dt>
<dd>More tests will be needed in this area.</dd>
</dl>
</section>
<section id='specifications'>
<h3>Specifications</h3>
<dl>
<dt>substantive</dt>
<dd>The reported issue will only be addressed with a substantive change. This tag could be combined with others (except <code>editorial</code>).</dd>
<dt>bug</dt>
<dd>The specification is broken or misleading and need to change.</dd>
<dt>enhancement</dt>
<dd>The specification works as-is but could be improved.</dd>
<dt>help wanted</dt>
<dd>The editor and/or Group need to resolve this issue.</dd>
<dt>invalid</dt>
<dd>This issue or pull request was declared out of scope.</dd>
<dt>duplicate</dt>
<dd>This issue or pull request is a duplicate and will be closed if not already closed.</dd>
<dt>wontfix</dt>
<dd>This issue won't get addressed. Best is to combine this one with others, sich as <code>invalid</code>.</dd>
<dt>w3c</dt>
<dd>This is used to track non-technical W3C Process related issues, such as transitions.</dd>
</dl>
</section>
</section>
<section id='milestones'>
<h2>Milestones</h2>
<a href="https://help.github.com/articles/tracking-the-progress-of-your-work-with-milestones/">Milestones</a> describe the scheduling of bug fixes and changes.
Often an issue is labeled with a particular milestone as a way to postpone work on it until after work needed for an earlier milestone.
<dl>
<dt>experiment</dt>
<dd>Resolve before experimenting with the new feature on general users.</dd>
<dt>migrate</dt>
<dd>Resolve before <a href="https://wicg.github.io/admin/intent-to-migrate.html">migrating</a> the spec from the <a href="https://www.w3.org/community/wicg/">WICG</a> to a Working Group.</dd>
<dt>FPWD</dt>
<dd>Resolve before creating a <a href="https://www.w3.org/2017/Process-20170301/#first-wd">First Public Working Draft</a>.</dd>
<dt>CR</dt>
<dd>Resolve before advancing the spec to <a href="https://www.w3.org/2017/Process-20170301/#candidate-rec">Candidate Recommendation</a>.</dd>
<dt>PR</dt>
<dd>Resolve before advancing the spec to <a href="https://www.w3.org/2017/Process-20170301/#rec-pr">Proposed Recommendation</a>.</dd>
<dt>REC</dt>
<dd>Resolve before advancing the spec to <a href="https://www.w3.org/2017/Process-20170301/#rec-publication">Recommendation</a>.</dd>
<dt>level-2</dt>
<dd>Work on these issues after the level-1 spec is complete.</dd>
<dt>future-work</dt>
<dd>Work on these issues at an unspecified time in the future.</dd>
</dl>
</section>
<section id='wide-review'>
<h2>Wide Review</h2>
<p>1-The WG processes the comment, and provides a resolution.</p>
<dl>
<dt>WR-open</dt>
<dd> Comment received, not yet processed by the WG </dd>
<dt>WR-pending</dt>
<dd> Discussed but pending WG resolution </dd>
<dt>WR-resolved</dt>
<dd> WG resolution, (approved by WG) </dd>
<dt>WR-spec-updated</dt>
<dd>WG resolution and spec updated </dd>
<dt>WR-resolved-partial</dt>
<dd>Partial WG resolution (partially approved by WG) </dd>
<dt>WR-spec-updated-partial</dt>
<dd>Partial WG resolution and spec updated </dd>
<dt>WR-rejected</dt>
<dd>Comment Rejected by WG</dd>
</dl>
<p> For each comment, please fill a "type" <a href="#type">with above labels</a></p>
<p>2-Once the WG has processed all comments, the next steps are to get approval from the commenter</p>
<dl>
<dt>WR-response-drafted</dt>
<dd>Response to commenter drafted by WG</dd>
<dt>WR-response-sent</dt>
<dd>Response send to commenter</dd>
<dt>WR-commenter-rejected</dt>
<dd> Response rejected by commenter </dd>
<dt>WR-commenter-agreed</dt>
<dd>Response agreed by commenter</dd>
<dt>WR-commenter-agreed-partial</dt>
<dd>Response partially agreed by commenter (needs more discussion)</dd>
<dt>WR-commenter-no-response</dt>
<dd>No Response received from commenter within the stated period </dd>
</dl>
<p>For more information please refer to the <a href="https://www.w3.org/wiki/TimedText/TTML2_Wide_Review"> TTWG wiki Wide Review page</a></p>.
<p>Note that groups may work on a level-2 spec concurrently with pushing the
level-1 spec through the Recommendation process, so repositories may need
milestones like "level-2-CR".</p>
</section>
<section id='projects'>
<h2 id="projects">Projects</h2>
<a href="https://help.github.com/articles/tracking-the-progress-of-your-work-with-project-boards/">Projects</a> describe separate features within a larger specification.
Usually, prefer to create a new repository to track greenfield feature development, and take it through the <a href="https://www.w3.org/blog/2015/07/wicg/">incubation process</a> instead of using a project within an existing spec repository.
Even when used, project names are generally not shared between specifications, so we don't list samples here.
</section>
</main>
<footer>
<address><a href="https://github.com/w3c/w3c.github.io/">We are on GitHub</a></address>
<p>
<a href="https://www.w3.org/"><img src="img/w3c.svg" width="65" height="45" alt="W3C Logo"></a>
</p>
</footer>
<script>
// populate horizontal reviews
fetch("hr-labels.json").then(res => res.json()).then(labels => {
// labels is an array of labels
const dts = document.querySelectorAll("#horizontal-reviews dl dt");
for (let index = 0; index < dts.length; index++) {
let dt = dts[index];
let className = dt.className;
if (className) {
let dd = dt.nextElementSibling;
let entries = "<dl class='labels'>";
labels.forEach(label => {
if (label.name.indexOf(className) === 0) {
let sublabel = label.name.substring(className.length+1);
entries+= `<dt id='${label.name}'><a href='https://github.com/${label.repo}/issues/?q=label%3A${sublabel}'
style='background-color: #${label.color}'>${label.name}</a></dt>
<dd>${label.longdesc}</dd>`;
}
})
let div = document.createElement("div");
div.innerHTML = entries;
dd.appendChild(div);
}
}
})
// populate specification labels
fetch("specification-labels.json").then(res => res.json()).then(labels => {
const dl = document.querySelector("#specifications dl");
let entries = "";
labels.forEach(label => {
entries+= `<dt id='${label.name}' style='background-color: #${label.color}'>${label.name}</a></dt>
<dd>${label.longdesc}</dd>`;
})
const frag = document.createDocumentFragment();
frag.innerHTML = entries;
dl.appendChild(frag);
})
</script>
</body>
</html>