| 2 |
|
|
| 3 |
Title: Introducing Debian Enhancement Proposals (DEPs) |
Title: Introducing Debian Enhancement Proposals (DEPs) |
| 4 |
DEP: 0 |
DEP: 0 |
| 5 |
State: DRAFT |
State: CANDIDATE |
| 6 |
Date: 2009-07-26 |
Date: 2009-07-26 |
| 7 |
Drivers: Stefano Zacchiroli <zack@debian.org>, |
Drivers: Stefano Zacchiroli <zack@debian.org>, |
| 8 |
Adeodato Simó <dato@net.com.org.es>, |
Adeodato Simó <dato@net.com.org.es>, |
| 37 |
because it's difficult to know whether it adjusts to the consensus |
because it's difficult to know whether it adjusts to the consensus |
| 38 |
reached during the discussion period. |
reached during the discussion period. |
| 39 |
|
|
| 40 |
As our normative documents rely on wide adoption of a practice before |
Our normative documents rely on wide adoption of a practice before |
| 41 |
documenting it, and adopters can be reluctant to make use of it before a |
documenting it, and adopters can be reluctant to make use of it before a |
| 42 |
clear indication that a practice has some consensus behind it, this |
clear indication that a practice has some consensus behind it. This |
| 43 |
creates a hard to break loop that this process hopes to alleviate, by |
creates a hard to break loop that this process hopes to alleviate, by |
| 44 |
providing a mechanism to reflect the status of each proposal, including |
providing a mechanism to reflect the status of each proposal, including |
| 45 |
whether it has reached consensus or not. |
whether it has reached consensus or not. |
| 107 |
Proposal states |
Proposal states |
| 108 |
--------------- |
--------------- |
| 109 |
|
|
| 110 |
|
<div style="float: right; text-align: center;"> |
| 111 |
|
[[!img deps/dep0/workflow.png size="500x250" alt="DEP state diagram"]] |
| 112 |
|
<br /> |
| 113 |
|
<span style="font-size: xx-small">DEP workflow: state diagram</span> |
| 114 |
|
</div> |
| 115 |
A given DEP can be in one of the following *states*: |
A given DEP can be in one of the following *states*: |
| 116 |
|
|
| 117 |
* DRAFT |
* DRAFT |
| 180 |
explicitly acknowledge so |
explicitly acknowledge so |
| 181 |
* there are no modifications to a DEP in DRAFT state for 6 months or |
* there are no modifications to a DEP in DRAFT state for 6 months or |
| 182 |
more |
more |
| 183 |
* there is no consensus that the implementation of a DEP in CANDIDATE |
* there is no consensus either on the draft text or on the fact that |
| 184 |
state is working satisfactorily |
the implementation is working satisfactorily |
| 185 |
|
|
| 186 |
#### ACCEPTED -> OBSOLETE: no longer relevant |
#### ACCEPTED -> OBSOLETE: no longer relevant |
| 187 |
|
|
| 195 |
|
|
| 196 |
In one of these states, no further actions are needed. |
In one of these states, no further actions are needed. |
| 197 |
|
|
| 198 |
|
It is recommended that DEPs in one of these states carry a reason |
| 199 |
|
describing why they have moved to such a state. |
| 200 |
|
|
| 201 |
|
|
| 202 |
What the drivers should do |
What the drivers should do |
| 203 |
-------------------------- |
-------------------------- |
| 204 |
|
|
| 205 |
The additional, hopefully small, burden of the DEP process falls on the |
The only additional burden of the DEP process falls on the shoulders of its |
| 206 |
shoulders of its drivers. They have to take care of all the practical |
drivers. They have to take care of all the practical work of writing |
| 207 |
work of writing and maintaining the draft, so that everyone else can |
and maintaining the text, so that everyone else can just continue |
| 208 |
just continue discussing things over e-mail as before. Driver's burden |
discussing things as before. Driver's burden can be summarized as: |
|
can be summarized as: |
|
| 209 |
|
|
| 210 |
* Write the draft. |
* Write the draft text and update it during discussion. |
|
* Update the draft during discussion. |
|
| 211 |
* Determine when (rough) consensus in discussion has been reached. |
* Determine when (rough) consensus in discussion has been reached. |
| 212 |
* Implement, or find volunteers to implement. |
* Implement, or find volunteers to implement. |
| 213 |
* Determine when consensus of implementation success has been reached, |
* Determine when consensus of implementation success has been reached, |
| 214 |
when the testing of the available implementation has been satisfactory. |
when the testing of the available implementation has been satisfactory. |
| 215 |
* Update the DEP with progress updates at suitable intervals, until the |
* Update the DEP with progress updates at suitable intervals, until the |
| 216 |
DEP has been accepted. |
DEP has been accepted (or rejected). |
| 217 |
|
|
| 218 |
If the drivers go missing in action, other people may step in and |
If the drivers go missing in action, other people may step in and |
| 219 |
courteously take over the driving position. |
courteously take over the driving position. |
| 220 |
|
|
| 221 |
|
**Note**: the drivers can of course participate in the discussion as |
| 222 |
|
everybody else, but have no special authority to impose their ideas to |
| 223 |
|
others. <q>DEP gives pencils, not hammers.</q> |
| 224 |
|
|
| 225 |
|
|
| 226 |
Format and content |
Format and content |
| 227 |
------------------ |
------------------ |
| 241 |
* Abstract: a short paragraph (formatted as the long Description in |
* Abstract: a short paragraph (formatted as the long Description in |
| 242 |
debian/control) |
debian/control) |
| 243 |
|
|
| 244 |
|
(Additionally, REJECTED DEPs can carry a "Reason:" field describing |
| 245 |
|
why they were rejected.) |
| 246 |
|
|
| 247 |
The rest of the file is free form. If the DEP is kept in a wiki, using |
The rest of the file is free form. If the DEP is kept in a wiki, using |
| 248 |
its markup syntax is, of course, a good idea. |
its markup syntax is, of course, a good idea. |
| 249 |
|
|
| 264 |
|
|
| 265 |
The DEP must have a license that is DFSG free. You may choose the |
The DEP must have a license that is DFSG free. You may choose the |
| 266 |
license freely, but the "Expat" license is recommended. The |
license freely, but the "Expat" license is recommended. The |
| 267 |
official URL for it is http://www.jclark.com/xml/copying.txt and |
official URL for it is <http://www.jclark.com/xml/copying.txt> and |
| 268 |
the license text is: |
the license text is: |
| 269 |
|
|
| 270 |
Copyright (c) <year> <your names> |
Copyright (c) <year> <your names> |
| 288 |
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
| 289 |
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| 290 |
|
|
| 291 |
The justification for this recommendation is that this license is the |
The justification for this recommendation is that this license is one |
| 292 |
most permissive of the well-known licenses. By using this license, it is |
of the most permissive of the well-known licenses. By using this |
| 293 |
easy to copy parts of the DEP to other places, such as documentation for |
license, it is easy to copy parts of the DEP to other places, such as |
| 294 |
Debian development or embedded in individual packages. |
documentation for Debian development or embedded in individual |
| 295 |
|
packages. |
| 296 |
|
|
| 297 |
|
|
| 298 |
|
|
| 334 |
The following copyright statement and license apply to DEP0 (this |
The following copyright statement and license apply to DEP0 (this |
| 335 |
document). |
document). |
| 336 |
|
|
| 337 |
Copyright (c) 2008 Stefano Zacchiroli, Adeodato Simó, Lars Wirzenius |
Copyright (c) 2008-2009 Stefano Zacchiroli, Adeodato Simó, Lars Wirzenius |
| 338 |
|
|
| 339 |
Permission is hereby granted, free of charge, to any person obtaining |
Permission is hereby granted, free of charge, to any person obtaining |
| 340 |
a copy of this software and associated documentation files (the |
a copy of this software and associated documentation files (the |
| 359 |
------- |
------- |
| 360 |
|
|
| 361 |
* 2009-07-26: |
* 2009-07-26: |
| 362 |
[ Stefano Zacchiroli ] |
[ Zack, Dato, Lars] |
| 363 |
* Re-word state description: describe separately states and |
* Re-word state description: describe separately states and |
| 364 |
transitions. |
transitions. |
| 365 |
* Rename "DROPPED" status to "REJECTED"; inhibit "resurrection" of |
* Rename "DROPPED" status to "REJECTED"; inhibit "resurrection" of |
| 366 |
REJECTED DEPs. |
REJECTED DEPs. |
| 367 |
[ Stefano Zacchiroli, Lars Wirzenius ] |
* Mention that dep.debian.net is the central archival place |
| 368 |
* mention that dep.debian.net is the central archival place |
* Stress that DEPs give no special powers to drivers, in the "driver |
| 369 |
|
role" section |
| 370 |
|
* Change the state of DEP0 to CANDIDATE |
| 371 |
|
|
| 372 |
* 2008-06-12: |
* 2008-06-12: |
| 373 |
[ Lars Wirzenius ] |
[ Lars Wirzenius ] |