-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathscep0001.html
More file actions
288 lines (247 loc) · 17.7 KB
/
scep0001.html
File metadata and controls
288 lines (247 loc) · 17.7 KB
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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
<!DOCTYPE html>
<html lang="en">
<head>
<title>Structured Commons :: SCEP0001 - The Structured Commons Enhancement Proposal Process </title>
<meta charset="utf-8" />
<link href="http://www.structured-commons.org/feeds/all.atom.xml" type="application/atom+xml" rel="alternate" title="Structured Commons Full Atom Feed" />
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width,initial-scale=1, maximum-scale=1">
<link rel="stylesheet" type="text/css" href="http://www.structured-commons.org/theme/gumby.css" />
<link rel="stylesheet" type="text/css" href="http://www.structured-commons.org/theme/style.css" />
<link rel="stylesheet" type="text/css" href="http://www.structured-commons.org/theme/pygment.css" />
<script src="http://www.structured-commons.org/theme/js/libs/modernizr-2.6.2.min.js"></script>
</head>
<body id="index" class="home">
<div class="container">
<div class="row">
<header id="banner" class="body">
<h1><a href="http://www.structured-commons.org">Structured Commons <strong></strong></a></h1>
</header><!-- /#banner -->
<div id="navigation" class="navbar row">
<a href="#" gumby-trigger="#navigation > ul" class="toggle"><i class="icon-menu"></i></a>
<ul class="columns">
<li><a href="http://www.structured-commons.org/online-forum.html">Forum</a></li>
<li><a href="http://www.structured-commons.org/index.html">About</a></li>
<li><a href="http://www.structured-commons.org/mission.html">Mission statement</a></li>
<li><a href="http://www.structured-commons.org/org.html">Organization</a></li>
<li><a href="http://www.structured-commons.org/participating.html">Participating</a></li>
<li><a href="http://www.structured-commons.org/scep0000.html">SCEPs</a></li>
</ul>
</div>
<!--<h1>SCEP0001 – SCEP0001 - The Structured Commons Enhancement Proposal Process</h1>-->
<table class="docinfo"><col class="docinfo-name" /><col class="docinfo-content" />
<tbody valign="top">
<tr class="field"><th class="docinfo-name">SCEP:</th><td class="field-body">1</td></tr>
<tr class="field"><th class="docinfo-name">Title:</th><td class="field-body">The Structured Commons Enhancement Proposal Process</td></tr>
<tr class="field"><th class="docinfo-name">Version:</th><td class="field-body">2452430edb3075800227e28a29a55eeddeb3423e</td></tr>
<tr class="field"><th class="docinfo-name">Last modified:</th><td class="field-body">2014-06-16 00:43:06 UTC (Mon, 16 June 2014)</td></tr>
<tr class="field"><th class="docinfo-name">Author:</th><td class="field-body">Structured Commons Technical Steering Committee</td></tr>
<tr class="field"><th class="docinfo-name">Status:</th><td class="field-body">Active</td></tr>
<tr class="field"><th class="docinfo-name">Type:</th><td class="field-body">Process</td></tr>
<tr class="field"><th class="docinfo-name">Created:</th><td class="field-body">2014-06-15</td></tr>
<tr class="field"><th class="docinfo-name">Source:</th><td class="field-body"><a href="scep0001.rst">scep0001.rst</a> (<tt>fp:7VbmCLSGV0sIDQiiyk9_NV2n0-d5Nwnlwc0wG31qT93vFQ</tt>)</td></tr>
</tbody></table>
<div class="section" id="what-is-a-scep">
<h2>What is a <span class="caps">SCEP</span></h2>
<p><span class="caps">SCEP</span> stands for Structured Commons Enhancement Proposal. A <span class="caps">SCEP</span> is a
design document providing information to the Structured Commons
community, or describing a new feature for the Structured Commons
methods and protocols. The <span class="caps">SCEP</span> should provide a concise technical
specification of the feature and a rationale for the feature.</p>
<p>We intend SCEPs to be the primary mechanisms for proposing new
features, for collecting community input on an issue, and for
documenting the design decisions that have gone into Structured Commons. The <span class="caps">SCEP</span>
author is responsible for building consensus within the community and
documenting dissenting opinions.</p>
<p>Because the SCEPs are maintained as reStructured text files in a
versioned repository, their revision history is the historical record
of the feature proposal <a class="footnote-reference" href="#id4" id="id1">[1]</a>. The list of all defined SCEPs is
maintained as <span class="caps">SCEP</span> 0 <a class="footnote-reference" href="#scep-0" id="id2">[3]</a>.</p>
</div>
<div class="section" id="scep-types">
<h2><span class="caps">SCEP</span> Types</h2>
<p>There are three kinds of <span class="caps">SCEP</span>:</p>
<blockquote>
<ol class="arabic simple">
<li>A Standards Track <span class="caps">SCEP</span> describes an extension to one of the
Structured Commons protocols, or a change in the behavior of one
of the actors in these protocols.</li>
<li>An Informational <span class="caps">SCEP</span> describes a Structured Commons design issue, or
provides general guidelines or information to the Structured Commons
community, but does not propose an extension. Informational SCEPs
do not necessarily represent a Structured Commons community consensus or
recommendation, so users and implementors are free to ignore
Informational SCEPs or follow their advice.</li>
<li>A Process <span class="caps">SCEP</span> describes a process surrounding the Structured Commons, or
proposes a change to (or an event in) a process. Process SCEPs are
like Standards Track SCEPs but apply to areas other than the
Structured Commons protocols. They are more than recommendations, and
users are typically not free to ignore them. Examples include
release schedules, procedures, guidelines, changes to the
decision-making process, and changes to the tools or environment
used in Structured Commons development.</li>
</ol>
</blockquote>
</div>
<div class="section" id="scep-work-flow">
<h2><span class="caps">SCEP</span> Work Flow</h2>
<p>The <span class="caps">SCEP</span> editors assign <span class="caps">SCEP</span> numbers and change their status.
Please send all <span class="caps">SCEP</span>-related email to <<a class="reference external" href="mailto:editors@structured-commons.org">editors@structured-commons.org</a>>.</p>
<p>The <span class="caps">SCEP</span> process begins with a new idea for the Structured Commons
protocols. It is highly recommended that a single <span class="caps">SCEP</span> contain a single
key proposal. The <span class="caps">SCEP</span> editor reserves the right to reject <span class="caps">SCEP</span>
proposals if they appear unfocussed or overly broad. If in doubt,
split your <span class="caps">SCEP</span> into muliple SCEPs.</p>
<p>Each <span class="caps">SCEP</span> must have a champion — someone who writes the <span class="caps">SCEP</span> using
the style and format described below, shepherds the discussions in the
appropriate forums, and attempts to build community consensus around
the idea. The <span class="caps">SCEP</span> champion should first post a description of the
idea to the SCEPs mailing list at:
<a class="reference external" href="http://lists.structured-commons.org/mailman/listinfo/sc-discuss">http://lists.structured-commons.org/mailman/listinfo/sc-discuss</a></p>
<p>If the champion believes the idea warrants a <span class="caps">SCEP</span> then the champion
emails the <span class="caps">SCEP</span> editor <<a class="reference external" href="mailto:editors@structured-commons.org">editors@structured-commons.org</a>> with a proposed title
and a draft of the <span class="caps">SCEP</span>. This draft must be written in <span class="caps">SCEP</span> style as
described below.</p>
<p>If the <span class="caps">SCEP</span> editor approves, he assigns the <span class="caps">SCEP</span> a number, labels it
as Standards Track, Informational, or Process, gives it status
"Draft", and creates and checks-in the initial draft of the <span class="caps">SCEP</span> to
the subversion repository. The <span class="caps">SCEP</span> editor will not unreasonably deny
a <span class="caps">SCEP</span>. Reasons for denying <span class="caps">SCEP</span> status include duplication of effort,
being technically unsound, not providing proper motivation or not
addressing backwards compatibility. The Structured Commons Technical
Steering Committee can be consulted during the approval phase, and is
the final arbiter of the draft’s <span class="caps">SCEP</span>-ability.</p>
<p>If a pre-<span class="caps">SCEP</span> is rejected, the author may elect to take the pre-<span class="caps">SCEP</span> to
the <span class="caps">SCEP</span> forum seeking feedback and consesnsus from the community at large.
A proposal may be re-submitted after it has been revised.</p>
<p>The champion is then responsible for marshaling community support for
it. As updates are necessary, the <span class="caps">SCEP</span> author can check in new
versions if they have commit permissions on the <span class="caps">SCEP</span> repository, or
can email new <span class="caps">SCEP</span> versions to the <span class="caps">SCEP</span> editors for committing.</p>
<p>Standards Track SCEPs consist of two parts, a design document and a
reference implementation. The reference implementation need not be
complete when a <span class="caps">SCEP</span> is submitted to the editors. However Standards
Track SCEPs must include an implementation with publicy available code
before it can be considered Final.</p>
<p><span class="caps">SCEP</span> champions are responsible for collecting community feedback on a
<span class="caps">SCEP</span> before submitting it for review. A <span class="caps">SCEP</span> that has not been
discussed in the Structured Commons mailing lists will not be
accepted. However, wherever possible, long open-ended discussions in
the mailing list should be avoided. Strategies to keep the discussions
efficient include: setting up a separate <span class="caps">SIG</span> forum for the topic,
having the <span class="caps">SCEP</span> author accept private comments in the early design
phases, setting up a wiki page, etc. <span class="caps">SCEP</span> authors should use their
discretion here.</p>
<p>Once the authors have completed a <span class="caps">SCEP</span>, they must inform the <span class="caps">SCEP</span>
editors that it is ready for review. SCEPs are reviewed by the
Technical Steering Committee, who may accept or reject a <span class="caps">SCEP</span> or send
it back to the author(s) for revision. For a <span class="caps">SCEP</span> that is
pre-determined to be acceptable (e.g., it is an obvious win as-is
and/or its implementation already exists) the Technical Steering
Committee may also initiate a <span class="caps">SCEP</span> review, first notifying the <span class="caps">SCEP</span>
author(s) and giving them a chance to make revisions.</p>
<p>For a <span class="caps">SCEP</span> to be accepted it must meet certain minimum criteria. It
must be a clear and complete description of the proposed
enhancement. The enhancement must represent a net improvement. The
proposed implementation, if applicable, must be functional and have
been tested in a live environment. Supporting results from
analyses, testbed experiments and event-based simulations are also
recommended where appropriate. A Standards Track document should
include the rationale behind a proposal and may briefly summarize
analytical, simulation, or experimental results where necessary to
illustrate or motivate the enhancement. However, detailed analytical,
simulation, and experiment results, especially comparing different
approaches to the same problem should be omitted from Standards Track
SCEPs and instead cited from a published paper or a separate
Informational <span class="caps">SCEP</span>.</p>
<p>Once a <span class="caps">SCEP</span> has been accepted, the reference implementation must be
completed. When the reference implementation is complete and accepted
by the <span class="caps">BDFL</span>, the status will be changed to "Final".</p>
<p>A <span class="caps">SCEP</span> can also be assigned status "Deferred". The <span class="caps">SCEP</span> author or editor
can assign the <span class="caps">SCEP</span> this status when no progress is being made on the
<span class="caps">SCEP</span>. Once a <span class="caps">SCEP</span> is deferred, the <span class="caps">SCEP</span> editor can re-assign it to draft status.</p>
<p>A <span class="caps">SCEP</span> can also be "Rejected". Perhaps after all is said and done it
was not a good idea. It is still important to have a record of this fact.</p>
<p>SCEPs can also be replaced by a different <span class="caps">SCEP</span>, rendering the original
obsolete. This is intended for Informational SCEPs, where e.g. version 2 of
an <span class="caps">API</span> can replace version 1.</p>
</div>
<div class="section" id="intellectual-property-and-structured-commons-standards">
<h2>Intellectual Property and Structured Commons Standards</h2>
<p>Any idea submitted in a <span class="caps">SCEP</span> will not be considered for standardization
if the idea is not in the public domain. Before a <span class="caps">SCEP</span> can be
considered Final, all people (including the <span class="caps">SCEP</span> authors) or entities
with a claim on the intellectual property expressed in a <span class="caps">SCEP</span> must
assign in writing all intellectual property expressed in the <span class="caps">SCEP</span> to
the public domain. If the <span class="caps">SCEP</span> authors lack the power to assign
intellectual property rights then they must disclose this fact before
the <span class="caps">SCEP</span> can be considered Final.</p>
<p>Furthermore <span class="caps">SCEP</span> authors should not knowingly propose anything in their
SCEPs that infringes on the intellectual property rights of others.</p>
<p>This policy statement should not be construed as meaning that <span class="caps">SCEP</span>
authors are required to assign software implementations of any
particular idea to the public domain. Structured Commons implementors may
retain all rights to their implementations.</p>
</div>
<div class="section" id="history">
<h2>History</h2>
<p>This document was derived heavily from <span class="caps">PEP</span>-0001 <a class="footnote-reference" href="#id5" id="id3">[2]</a>. In many places
text was simply copied and modified. Although the <span class="caps">PEP</span>-0001 text
was written by Barry Warsaw, Jeremy Hylton, and David Goodger, they
are not responsible for its use in the Structured Commons Enhancement Process,
and should not be bothered with technical questions specific to
Structured Commons or the <span class="caps">SCEP</span> process. Please direct all comments to the
<span class="caps">SCEP</span> editors <<a class="reference external" href="mailto:editors@structured-commons.org">editors@structured-commons.org</a>> or the mailing list
at: <a class="reference external" href="http://lists.structured-commons.org/mailman/listinfo/sc-discuss">http://lists.structured-commons.org/mailman/listinfo/sc-discuss</a></p>
<div class="section" id="references">
<h3>References</h3>
<table class="docutils footnote" frame="void" id="id4" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td><a class="reference external" href="https://github.com/structured-commons/structured-commons.github.io/tree/master/src/content/pages/sceps">https://github.com/structured-commons/structured-commons.github.io/tree/master/src/content/pages/sceps</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id5" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id3">[2]</a></td><td><a class="reference external" href="http://www.python.org/dev/peps/pep-0001/">http://www.python.org/dev/peps/pep-0001/</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="scep-0" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id2">[3]</a></td><td><span class="caps">SCEP0000</span>. Index of Structured Commons Enhancement Proposals.
(<a class="reference external" href="http://www.structured-commons.org/scep0000.html">http://www.structured-commons.org/scep0000.html</a>)</td></tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="copyright">
<h2>Copyright</h2>
<p>This document has been placed in the public domain.</p>
</div>
</div><!-- /.row -->
</div><!-- /.container -->
<div class="container.nopad bg">
<footer id="credits" class="row">
<div class="seven columns left-center">
<address id="about" class="vcard body">
Proudly powered by <a href="http://getpelican.com/">Pelican</a>,
which takes great advantage of <a href="http://python.org">Python</a>.
<br />
Based on the <a target="_blank" href="http://gumbyframework.com">Gumby Framework</a>
</address>
</div>
<div class="seven columns">
<div class="row">
<ul class="socbtns">
</ul>
</div>
</div>
</footer>
</div>
<script src="http://www.structured-commons.org/theme/js/libs/jquery-1.9.1.min.js"></script>
<script src="http://www.structured-commons.org/theme/js/libs/gumby.min.js"></script>
<script src="http://www.structured-commons.org/theme/js/plugins.js"></script>
</body>
</html>