| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "PERLPOLICY 1" |
| 58 |
.TH PERLPOLICY 1 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide" |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
perlpolicy \- Various and sundry policies and commitments related to the Perl core |
| 65 |
.SH DESCRIPTION |
| 66 |
.IX Header "DESCRIPTION" |
| 67 |
This document is the master document which records all written |
| 68 |
policies about how the Perl 5 Porters collectively develop and maintain |
| 69 |
the Perl core. |
| 70 |
.SH GOVERNANCE |
| 71 |
.IX Header "GOVERNANCE" |
| 72 |
.SS "Perl 5 Porters" |
| 73 |
.IX Subsection "Perl 5 Porters" |
| 74 |
Subscribers to perl5\-porters (the porters themselves) come in several flavours. |
| 75 |
Some are quiet curious lurkers, who rarely pitch in and instead watch |
| 76 |
the ongoing development to ensure they're forewarned of new changes or |
| 77 |
features in Perl. Some are representatives of vendors, who are there |
| 78 |
to make sure that Perl continues to compile and work on their |
| 79 |
platforms. Some patch any reported bug that they know how to fix, |
| 80 |
some are actively patching their pet area (threads, Win32, the regexp |
| 81 |
\&\-engine), while others seem to do nothing but complain. In other |
| 82 |
words, it's your usual mix of technical people. |
| 83 |
.PP |
| 84 |
Among these people are the core Perl team. These are trusted volunteers |
| 85 |
involved in the ongoing development of the Perl language and interpreter. |
| 86 |
They are not required to be language developers or committers. |
| 87 |
.PP |
| 88 |
Over this group of porters presides Larry Wall. He has the final word |
| 89 |
in what does and does not change in any of the Perl programming languages. |
| 90 |
These days, Larry spends most of his time on Raku, while Perl 5 is |
| 91 |
shepherded by a steering council of porters responsible for deciding what |
| 92 |
goes into each release and ensuring that releases happen on a regular |
| 93 |
basis. |
| 94 |
.PP |
| 95 |
Larry sees Perl development along the lines of the US government: |
| 96 |
there's the Legislature (the porters, represented by the core team), the |
| 97 |
Executive branch (the steering council), and the Supreme Court (Larry). |
| 98 |
The legislature can discuss and submit patches to the executive branch |
| 99 |
all they like, but the executive branch is free to veto them. Rarely, |
| 100 |
the Supreme Court will side with the executive branch over the |
| 101 |
legislature, or the legislature over the executive branch. Mostly, |
| 102 |
however, the legislature and the executive branch are supposed to get |
| 103 |
along and work out their differences without impeachment or court cases. |
| 104 |
.PP |
| 105 |
You might sometimes see reference to Rule 1 and Rule 2. Larry's power |
| 106 |
as Supreme Court is expressed in The Rules: |
| 107 |
.IP 1. 4 |
| 108 |
Larry is always by definition right about how Perl should behave. |
| 109 |
This means he has final veto power on the core functionality. |
| 110 |
.IP 2. 4 |
| 111 |
Larry is allowed to change his mind about any matter at a later date, |
| 112 |
regardless of whether he previously invoked Rule 1. |
| 113 |
.PP |
| 114 |
Got that? Larry is always right, even when he was wrong. It's rare |
| 115 |
to see either Rule exercised, but they are often alluded to. |
| 116 |
.PP |
| 117 |
For the specifics on how the members of the core team and steering |
| 118 |
council are elected or rotated, consult perlgov, which spells it all |
| 119 |
out in detail. |
| 120 |
.SH "MAINTENANCE AND SUPPORT" |
| 121 |
.IX Header "MAINTENANCE AND SUPPORT" |
| 122 |
Perl 5 is developed by a community, not a corporate entity. Every change |
| 123 |
contributed to the Perl core is the result of a donation. Typically, these |
| 124 |
donations are contributions of code or time by individual members of our |
| 125 |
community. On occasion, these donations come in the form of corporate |
| 126 |
or organizational sponsorship of a particular individual or project. |
| 127 |
.PP |
| 128 |
As a volunteer organization, the commitments we make are heavily dependent |
| 129 |
on the goodwill and hard work of individuals who have no obligation to |
| 130 |
contribute to Perl. |
| 131 |
.PP |
| 132 |
That being said, we value Perl's stability and security and have long |
| 133 |
had an unwritten covenant with the broader Perl community to support |
| 134 |
and maintain releases of Perl. |
| 135 |
.PP |
| 136 |
This document codifies the support and maintenance commitments that |
| 137 |
the Perl community should expect from Perl's developers: |
| 138 |
.IP \(bu 4 |
| 139 |
We "officially" support the two most recent stable release series. 5.36.x |
| 140 |
and earlier are now out of support. As of the release of 5.42.0, we will |
| 141 |
"officially" end support for Perl 5.38.x, other than providing security |
| 142 |
updates as described below. |
| 143 |
.IP \(bu 4 |
| 144 |
To the best of our ability, we will attempt to fix critical issues |
| 145 |
in the two most recent stable 5.x release series. Fixes for the |
| 146 |
current release series take precedence over fixes for the previous |
| 147 |
release series. |
| 148 |
.IP \(bu 4 |
| 149 |
To the best of our ability, we will provide "critical" security patches |
| 150 |
/ releases for any major version of Perl whose 5.x.0 release was within |
| 151 |
the past three years. We can only commit to providing these for the |
| 152 |
most recent .y release in any 5.x.y series. |
| 153 |
.IP \(bu 4 |
| 154 |
We will not provide security updates or bug fixes for development |
| 155 |
releases of Perl. |
| 156 |
.IP \(bu 4 |
| 157 |
We encourage vendors to ship the most recent supported release of |
| 158 |
Perl at the time of their code freeze. |
| 159 |
.IP \(bu 4 |
| 160 |
As a vendor, you may have a requirement to backport security fixes |
| 161 |
beyond our 3 year support commitment. We can provide limited support and |
| 162 |
advice to you as you do so and, where possible will try to apply |
| 163 |
those patches to the relevant \-maint branches in git, though we may or |
| 164 |
may not choose to make numbered releases or "official" patches |
| 165 |
available. See "SECURITY VULNERABILITY CONTACT INFORMATION" in perlsec |
| 166 |
for details on how to begin that process. |
| 167 |
.SH "BACKWARD COMPATIBILITY AND DEPRECATION" |
| 168 |
.IX Header "BACKWARD COMPATIBILITY AND DEPRECATION" |
| 169 |
Our community has a long-held belief that backward-compatibility is a |
| 170 |
virtue, even when the functionality in question is a design flaw. |
| 171 |
.PP |
| 172 |
We would all love to unmake some mistakes we've made over the past |
| 173 |
decades. Living with every design error we've ever made can lead |
| 174 |
to painful stagnation. Unwinding our mistakes is very, very |
| 175 |
difficult. Doing so without actively harming our users is |
| 176 |
nearly impossible. |
| 177 |
.PP |
| 178 |
Lately, ignoring or actively opposing compatibility with earlier versions |
| 179 |
of Perl has come into vogue. Sometimes, a change is proposed which |
| 180 |
wants to usurp syntax which previously had another meaning. Sometimes, |
| 181 |
a change wants to improve previously-crazy semantics. |
| 182 |
.PP |
| 183 |
Down this road lies madness. |
| 184 |
.PP |
| 185 |
Requiring end-user programmers to change just a few language constructs, |
| 186 |
even language constructs which no well-educated developer would ever |
| 187 |
intentionally use is tantamount to saying "you should not upgrade to |
| 188 |
a new release of Perl unless you have 100% test coverage and can do a |
| 189 |
full manual audit of your codebase." If we were to have tools capable of |
| 190 |
reliably upgrading Perl source code from one version of Perl to another, |
| 191 |
this concern could be significantly mitigated. |
| 192 |
.PP |
| 193 |
We want to ensure that Perl continues to grow and flourish in the coming |
| 194 |
years and decades, but not at the expense of our user community. |
| 195 |
.PP |
| 196 |
Existing syntax and semantics should only be marked for destruction in |
| 197 |
very limited circumstances. If they are believed to be very rarely used, |
| 198 |
stand in the way of actual improvement to the Perl language or perl |
| 199 |
interpreter, and if affected code can be easily updated to continue |
| 200 |
working, they may be considered for removal. When in doubt, caution |
| 201 |
dictates that we will favor backward compatibility. When a feature is |
| 202 |
deprecated, a statement of reasoning describing the decision process |
| 203 |
will be posted, and a link to it will be provided in the relevant |
| 204 |
perldelta documents. |
| 205 |
.PP |
| 206 |
Using a lexical pragma to enable or disable legacy behavior should be |
| 207 |
considered when appropriate, and in the absence of any pragma legacy |
| 208 |
behavior should be enabled. Which backward-incompatible changes are |
| 209 |
controlled implicitly by a 'use v5.x.y' is a decision which should be |
| 210 |
made by the steering council in consultation with the community. |
| 211 |
.PP |
| 212 |
Historically, we've held ourselves to a far higher standard than |
| 213 |
backward-compatibility \-\- bugward-compatibility. Any accident of |
| 214 |
implementation or unintentional side-effect of running some bit of code |
| 215 |
has been considered to be a feature of the language to be defended with |
| 216 |
the same zeal as any other feature or functionality. No matter how |
| 217 |
frustrating these unintentional features may be to us as we continue |
| 218 |
to improve Perl, these unintentional features often deserve our |
| 219 |
protection. It is very important that existing software written in |
| 220 |
Perl continue to work correctly. If end-user developers have adopted a |
| 221 |
bug as a feature, we need to treat it as such. |
| 222 |
.PP |
| 223 |
New syntax and semantics which don't break existing language constructs |
| 224 |
and syntax have a much lower bar. They merely need to prove themselves |
| 225 |
to be useful, elegant, well designed, and well tested. In most cases, |
| 226 |
these additions will be marked as \fIexperimental\fR for some time. See |
| 227 |
below for more on that. |
| 228 |
.SS Terminology |
| 229 |
.IX Subsection "Terminology" |
| 230 |
To make sure we're talking about the same thing when we discuss the removal |
| 231 |
of features or functionality from the Perl core, we have specific definitions |
| 232 |
for a few words and phrases. |
| 233 |
.IP experimental 4 |
| 234 |
.IX Item "experimental" |
| 235 |
If something in the Perl core is marked as \fBexperimental\fR, we may change |
| 236 |
its behaviour, deprecate or remove it without notice. While we'll always |
| 237 |
do our best to smooth the transition path for users of experimental |
| 238 |
features, you should contact the perl5\-porters mailinglist if you find |
| 239 |
an experimental feature useful and want to help shape its future. |
| 240 |
.Sp |
| 241 |
Experimental features must be experimental in two stable releases before being |
| 242 |
marked non-experimental. Experimental features will only have their |
| 243 |
experimental status revoked when they no longer have any design-changing bugs |
| 244 |
open against them and when they have remained unchanged in behavior for the |
| 245 |
entire length of a development cycle. In other words, a feature present in |
| 246 |
v5.20.0 may be marked no longer experimental in v5.22.0 if and only if its |
| 247 |
behavior is unchanged throughout all of v5.21. |
| 248 |
.IP deprecated 4 |
| 249 |
.IX Item "deprecated" |
| 250 |
If something in the Perl core is marked as \fBdeprecated\fR, we may remove it |
| 251 |
from the core in the future, though we might not. Generally, backward |
| 252 |
incompatible changes will have deprecation warnings for two release |
| 253 |
cycles before being removed, but may be removed after just one cycle if |
| 254 |
the risk seems quite low or the benefits quite high. |
| 255 |
.Sp |
| 256 |
As of |
| 257 |
Perl 5.12, deprecated features and modules warn the user as they're used. |
| 258 |
When a module is deprecated, it will also be made available on CPAN. |
| 259 |
Installing it from CPAN will silence deprecation warnings for that module. |
| 260 |
.Sp |
| 261 |
If you use a deprecated feature or module and believe that its removal from |
| 262 |
the Perl core would be a mistake, please contact the perl5\-porters |
| 263 |
mailinglist and plead your case. We don't deprecate things without a good |
| 264 |
reason, but sometimes there's a counterargument we haven't considered. |
| 265 |
Historically, we did not distinguish between "deprecated" and "discouraged" |
| 266 |
features. |
| 267 |
.IP discouraged 4 |
| 268 |
.IX Item "discouraged" |
| 269 |
From time to time, we may mark language constructs and features which we |
| 270 |
consider to have been mistakes as \fBdiscouraged\fR. Discouraged features |
| 271 |
aren't currently candidates for removal, but |
| 272 |
we may later deprecate them if they're found to stand in the way of a |
| 273 |
significant improvement to the Perl core. |
| 274 |
.IP removed 4 |
| 275 |
.IX Item "removed" |
| 276 |
Once a feature, construct or module has been marked as deprecated, we |
| 277 |
may remove it from the Perl core. Unsurprisingly, |
| 278 |
we say we've \fBremoved\fR these things. When a module is removed, it will |
| 279 |
no longer ship with Perl, but will continue to be available on CPAN. |
| 280 |
.SH "MAINTENANCE BRANCHES" |
| 281 |
.IX Header "MAINTENANCE BRANCHES" |
| 282 |
New releases of maintenance branches should only contain changes that fall into |
| 283 |
one of the "acceptable" categories set out below, but must not contain any |
| 284 |
changes that fall into one of the "unacceptable" categories. (For example, a |
| 285 |
fix for a crashing bug must not be included if it breaks binary compatibility.) |
| 286 |
.PP |
| 287 |
It is not necessary to include every change meeting these criteria, and in |
| 288 |
general the focus should be on addressing security issues, crashing bugs, |
| 289 |
regressions and serious installation issues. The temptation to include a |
| 290 |
plethora of minor changes that don't affect the installation or execution of |
| 291 |
perl (e.g. spelling corrections in documentation) should be resisted in order |
| 292 |
to reduce the overall risk of overlooking something. The intention is to |
| 293 |
create maintenance releases which are both worthwhile and which users can have |
| 294 |
full confidence in the stability of. (A secondary concern is to avoid burning |
| 295 |
out the maint-release manager or overwhelming other committers voting on |
| 296 |
changes to be included (see "Getting changes into a maint branch" |
| 297 |
below).) |
| 298 |
.PP |
| 299 |
The following types of change may be considered acceptable, as long as they do |
| 300 |
not also fall into any of the "unacceptable" categories set out below: |
| 301 |
.IP \(bu 4 |
| 302 |
Patches that fix CVEs or security issues. These changes should |
| 303 |
be passed using the security reporting mechanism rather than applied |
| 304 |
directly; see "SECURITY VULNERABILITY CONTACT INFORMATION" in perlsec. |
| 305 |
.IP \(bu 4 |
| 306 |
Patches that fix crashing bugs, assertion failures and |
| 307 |
memory corruption but which do not otherwise change perl's |
| 308 |
functionality or negatively impact performance. |
| 309 |
.IP \(bu 4 |
| 310 |
Patches that fix regressions in perl's behavior relative to previous |
| 311 |
releases, no matter how old the regression, since some people may |
| 312 |
upgrade from very old versions of perl to the latest version. |
| 313 |
.IP \(bu 4 |
| 314 |
Patches that fix bugs in features that were new in the corresponding 5.x.0 |
| 315 |
stable release. |
| 316 |
.IP \(bu 4 |
| 317 |
Patches that fix anything which prevents or seriously impacts the build |
| 318 |
or installation of perl. |
| 319 |
.IP \(bu 4 |
| 320 |
Portability fixes, such as changes to Configure and the files in |
| 321 |
the hints/ folder. |
| 322 |
.IP \(bu 4 |
| 323 |
Minimal patches that fix platform-specific test failures. |
| 324 |
.IP \(bu 4 |
| 325 |
Documentation updates that correct factual errors, explain significant |
| 326 |
bugs or deficiencies in the current implementation, or fix broken markup. |
| 327 |
.IP \(bu 4 |
| 328 |
Updates to dual-life modules should consist of minimal patches to |
| 329 |
fix crashing bugs or security issues (as above). Any changes made to |
| 330 |
dual-life modules for which CPAN is canonical should be coordinated with |
| 331 |
the upstream author. |
| 332 |
.PP |
| 333 |
The following types of change are NOT acceptable: |
| 334 |
.IP \(bu 4 |
| 335 |
Patches that break binary compatibility. (Please talk to the steering |
| 336 |
council.) |
| 337 |
.IP \(bu 4 |
| 338 |
Patches that add or remove features. |
| 339 |
.IP \(bu 4 |
| 340 |
Patches that add new warnings or errors or deprecate features. |
| 341 |
.IP \(bu 4 |
| 342 |
Ports of Perl to a new platform, architecture or OS release that |
| 343 |
involve changes to the implementation. |
| 344 |
.IP \(bu 4 |
| 345 |
New versions of dual-life modules should NOT be imported into maint. |
| 346 |
Those belong in the next stable series. |
| 347 |
.PP |
| 348 |
If there is any question about whether a given patch might merit |
| 349 |
inclusion in a maint release, then it almost certainly should not |
| 350 |
be included. |
| 351 |
.SS "Getting changes into a maint branch" |
| 352 |
.IX Subsection "Getting changes into a maint branch" |
| 353 |
Historically, only the single-person project manager cherry-picked |
| 354 |
changes from bleadperl into maintperl. This has scaling problems. At |
| 355 |
the same time, maintenance branches of stable versions of Perl need to |
| 356 |
be treated with great care. To that end, as of Perl 5.12, we have a new |
| 357 |
process for maint branches. |
| 358 |
.PP |
| 359 |
Any committer may cherry-pick any commit from blead to a maint branch by |
| 360 |
first adding an entry to the relevant voting file in the maint-votes branch |
| 361 |
announcing the commit as a candidate for back-porting, and then waiting for |
| 362 |
at least two other committers to add their votes in support of this (i.e. a |
| 363 |
total of at least three votes is required before a commit may be back-ported). |
| 364 |
.PP |
| 365 |
Most of the work involved in both rounding up a suitable set of candidate |
| 366 |
commits and cherry-picking those for which three votes have been cast will |
| 367 |
be done by the maint branch release manager, but anyone else is free to add |
| 368 |
other proposals if they're keen to ensure certain fixes don't get overlooked |
| 369 |
or fear they already have been. |
| 370 |
.PP |
| 371 |
Other voting mechanisms may also be used instead (e.g. sending mail to |
| 372 |
perl5\-porters and at least two other committers responding to the list |
| 373 |
giving their assent), as long as the same number of votes is gathered in a |
| 374 |
transparent manner. Specifically, proposals of which changes to cherry-pick |
| 375 |
must be visible to everyone on perl5\-porters so that the views of everyone |
| 376 |
interested may be heard. |
| 377 |
.PP |
| 378 |
It is not necessary for voting to be held on cherry-picking perldelta |
| 379 |
entries associated with changes that have already been cherry-picked, nor |
| 380 |
for the maint-release manager to obtain votes on changes required by the |
| 381 |
\&\fIPorting/release_managers_guide.pod\fR where such changes can be applied by |
| 382 |
the means of cherry-picking from blead. |
| 383 |
.SH "CONTRIBUTED MODULES" |
| 384 |
.IX Header "CONTRIBUTED MODULES" |
| 385 |
.SS "A Social Contract about Artistic Control" |
| 386 |
.IX Subsection "A Social Contract about Artistic Control" |
| 387 |
What follows is a statement about artistic control, defined as the ability |
| 388 |
of authors of packages to guide the future of their code and maintain |
| 389 |
control over their work. It is a recognition that authors should have |
| 390 |
control over their work, and that it is a responsibility of the rest of |
| 391 |
the Perl community to ensure that they retain this control. It is an |
| 392 |
attempt to document the standards to which we, as Perl developers, intend |
| 393 |
to hold ourselves. It is an attempt to write down rough guidelines about |
| 394 |
the respect we owe each other as Perl developers. |
| 395 |
.PP |
| 396 |
This statement is not a legal contract. This statement is not a legal |
| 397 |
document in any way, shape, or form. Perl is distributed under the GNU |
| 398 |
Public License and under the Artistic License; those are the precise legal |
| 399 |
terms. This statement isn't about the law or licenses. It's about |
| 400 |
community, mutual respect, trust, and good-faith cooperation. |
| 401 |
.PP |
| 402 |
We recognize that the Perl core, defined as the software distributed with |
| 403 |
the heart of Perl itself, is a joint project on the part of all of us. |
| 404 |
From time to time, a script, module, or set of modules (hereafter referred |
| 405 |
to simply as a "module") will prove so widely useful and/or so integral to |
| 406 |
the correct functioning of Perl itself that it should be distributed with |
| 407 |
the Perl core. This should never be done without the author's explicit |
| 408 |
consent, and a clear recognition on all parts that this means the module |
| 409 |
is being distributed under the same terms as Perl itself. A module author |
| 410 |
should realize that inclusion of a module into the Perl core will |
| 411 |
necessarily mean some loss of control over it, since changes may |
| 412 |
occasionally have to be made on short notice or for consistency with the |
| 413 |
rest of Perl. |
| 414 |
.PP |
| 415 |
Once a module has been included in the Perl core, however, everyone |
| 416 |
involved in maintaining Perl should be aware that the module is still the |
| 417 |
property of the original author unless the original author explicitly |
| 418 |
gives up their ownership of it. In particular: |
| 419 |
.IP \(bu 4 |
| 420 |
The version of the module in the Perl core should still be considered the |
| 421 |
work of the original author. All patches, bug reports, and so |
| 422 |
forth should be fed back to them. Their development directions |
| 423 |
should be respected whenever possible. |
| 424 |
.IP \(bu 4 |
| 425 |
Patches may be applied by the steering council without the explicit |
| 426 |
cooperation of the module author if and only if they are very minor, |
| 427 |
time-critical in some fashion (such as urgent security fixes), or if |
| 428 |
the module author cannot be reached. Those patches must still be |
| 429 |
given back to the author when possible, and if the author decides on |
| 430 |
an alternate fix in their version, that fix should be strongly |
| 431 |
preferred unless there is a serious problem with it. Any changes not |
| 432 |
endorsed by the author should be marked as such, and the contributor |
| 433 |
of the change acknowledged. |
| 434 |
.IP \(bu 4 |
| 435 |
The version of the module distributed with Perl should, whenever |
| 436 |
possible, be the latest version of the module as distributed by the |
| 437 |
author (the latest non-beta version in the case of public Perl |
| 438 |
releases), although the steering council may hold off on upgrading the |
| 439 |
version of the module distributed with Perl to the latest version |
| 440 |
until the latest version has had sufficient testing. |
| 441 |
.PP |
| 442 |
In other words, the author of a module should be considered to have final |
| 443 |
say on modifications to their module whenever possible (bearing in mind |
| 444 |
that it's expected that everyone involved will work together and arrive at |
| 445 |
reasonable compromises when there are disagreements). |
| 446 |
.PP |
| 447 |
As a last resort, however: |
| 448 |
.PP |
| 449 |
If the author's vision of the future of their module is sufficiently |
| 450 |
different from the vision of the steering council and perl5\-porters as a |
| 451 |
whole so as to cause serious problems for Perl, the steering council may |
| 452 |
choose to formally fork the version of the module in the Perl core from the |
| 453 |
one maintained by the author. This should not be done lightly and |
| 454 |
should \fBalways\fR if at all possible be done only after direct input |
| 455 |
from Larry. If this is done, it must then be made explicit in the |
| 456 |
module as distributed with the Perl core that it is a forked version and |
| 457 |
that while it is based on the original author's work, it is no longer |
| 458 |
maintained by them. This must be noted in both the documentation and |
| 459 |
in the comments in the source of the module. |
| 460 |
.PP |
| 461 |
Again, this should be a last resort only. Ideally, this should never |
| 462 |
happen, and every possible effort at cooperation and compromise should be |
| 463 |
made before doing this. If it does prove necessary to fork a module for |
| 464 |
the overall health of Perl, proper credit must be given to the original |
| 465 |
author in perpetuity and the decision should be constantly re-evaluated to |
| 466 |
see if a remerging of the two branches is possible down the road. |
| 467 |
.PP |
| 468 |
In all dealings with contributed modules, everyone maintaining Perl should |
| 469 |
keep in mind that the code belongs to the original author, that they may |
| 470 |
not be on perl5\-porters at any given time, and that a patch is not |
| 471 |
official unless it has been integrated into the author's copy of the |
| 472 |
module. To aid with this, and with points #1, #2, and #3 above, contact |
| 473 |
information for the authors of all contributed modules should be kept with |
| 474 |
the Perl distribution. |
| 475 |
.PP |
| 476 |
Finally, the Perl community as a whole recognizes that respect for |
| 477 |
ownership of code, respect for artistic control, proper credit, and active |
| 478 |
effort to prevent unintentional code skew or communication gaps is vital |
| 479 |
to the health of the community and Perl itself. Members of a community |
| 480 |
should not normally have to resort to rules and laws to deal with each |
| 481 |
other, and this document, although it contains rules so as to be clear, is |
| 482 |
about an attitude and general approach. The first step in any dispute |
| 483 |
should be open communication, respect for opposing views, and an attempt |
| 484 |
at a compromise. In nearly every circumstance nothing more will be |
| 485 |
necessary, and certainly no more drastic measure should be used until |
| 486 |
every avenue of communication and discussion has failed. |
| 487 |
.SH DOCUMENTATION |
| 488 |
.IX Header "DOCUMENTATION" |
| 489 |
Perl's documentation is an important resource for our users. It's |
| 490 |
incredibly important for Perl's documentation to be reasonably coherent |
| 491 |
and to accurately reflect the current implementation. |
| 492 |
.PP |
| 493 |
Just as P5P collectively maintains the codebase, we collectively |
| 494 |
maintain the documentation. Writing a particular bit of documentation |
| 495 |
doesn't give an author control of the future of that documentation. |
| 496 |
At the same time, just as source code changes should match the style |
| 497 |
of their surrounding blocks, so should documentation changes. |
| 498 |
.PP |
| 499 |
Examples in documentation should be illustrative of the concept |
| 500 |
they're explaining. Sometimes, the best way to show how a |
| 501 |
language feature works is with a small program the reader can |
| 502 |
run without modification. More often, examples will consist |
| 503 |
of a snippet of code containing only the "important" bits. |
| 504 |
The definition of "important" varies from snippet to snippet. |
| 505 |
Sometimes it's important to declare \f(CW\*(C`use strict\*(C'\fR and \f(CW\*(C`use warnings\*(C'\fR, |
| 506 |
initialize all variables and fully catch every error condition. |
| 507 |
More often than not, though, those things obscure the lesson |
| 508 |
the example was intended to teach. |
| 509 |
.PP |
| 510 |
As Perl is developed by a global team of volunteers, our |
| 511 |
documentation often contains spellings which look funny |
| 512 |
to \fIsomebody\fR. Choice of American/British/Other spellings |
| 513 |
is left as an exercise for the author of each bit of |
| 514 |
documentation. When patching documentation, try to emulate |
| 515 |
the documentation around you, rather than changing the existing |
| 516 |
prose. |
| 517 |
.PP |
| 518 |
In general, documentation should describe what Perl does "now" rather |
| 519 |
than what it used to do. It's perfectly reasonable to include notes |
| 520 |
in documentation about how behaviour has changed from previous releases, |
| 521 |
but, with very few exceptions, documentation isn't "dual-life" \-\- |
| 522 |
it doesn't need to fully describe how all old versions used to work. |
| 523 |
.SH "STANDARDS OF CONDUCT" |
| 524 |
.IX Header "STANDARDS OF CONDUCT" |
| 525 |
The official forum for the development of perl is the perl5\-porters mailing |
| 526 |
list, mentioned above, and its bugtracker at GitHub. Posting to the |
| 527 |
list and the bugtracker is not a right: all participants in discussion are |
| 528 |
expected to adhere to a standard of conduct. |
| 529 |
.IP \(bu 4 |
| 530 |
Always be civil. |
| 531 |
.IP \(bu 4 |
| 532 |
Heed the moderators. |
| 533 |
.PP |
| 534 |
Civility is simple: stick to the facts while avoiding demeaning remarks, |
| 535 |
belittling other individuals, sarcasm, or a presumption of bad faith. It is |
| 536 |
not enough to be factual. You must also be civil. Responding in kind to |
| 537 |
incivility is not acceptable. If you relay otherwise-unposted comments to |
| 538 |
the list from a third party, you take responsibility for the content of |
| 539 |
those comments, and you must therefore ensure that they are civil. |
| 540 |
.PP |
| 541 |
While civility is required, kindness is encouraged; if you have any doubt about |
| 542 |
whether you are being civil, simply ask yourself, "Am I being kind?" and aspire |
| 543 |
to that. |
| 544 |
.PP |
| 545 |
If the list moderators tell you that you are not being civil, carefully |
| 546 |
consider how your words have appeared before responding in any way. Were they |
| 547 |
kind? You may protest, but repeated protest in the face of a repeatedly |
| 548 |
reaffirmed decision is not acceptable. Repeatedly protesting about the |
| 549 |
moderators' decisions regarding a third party is also unacceptable, as is |
| 550 |
continuing to initiate off-list contact with the moderators about their |
| 551 |
decisions. |
| 552 |
.PP |
| 553 |
Unacceptable behavior will result in a public and clearly identified |
| 554 |
warning. A second instance of unacceptable behavior from the same |
| 555 |
individual will result in removal from the mailing list and GitHub issue |
| 556 |
tracker, for a period of one calendar month. The rationale for this is to |
| 557 |
provide an opportunity for the person to change the way they act. |
| 558 |
.PP |
| 559 |
After the time-limited ban has been lifted, a third instance of |
| 560 |
unacceptable behavior will result in a further public warning. A fourth |
| 561 |
or subsequent instance will result in an indefinite ban. The rationale |
| 562 |
is that, in the face of an apparent refusal to change behavior, we must |
| 563 |
protect other community members from future unacceptable actions. The |
| 564 |
moderators may choose to lift an indefinite ban if the person in |
| 565 |
question affirms they will not transgress again. |
| 566 |
.PP |
| 567 |
Removals, like warnings, are public. |
| 568 |
.PP |
| 569 |
The list of moderators will be public knowledge. At present, it is: |
| 570 |
Karen Etheridge, Neil Bowers, Nicholas Clark, Ricardo Signes, Todd Rinaldo. |
| 571 |
.SH CREDITS |
| 572 |
.IX Header "CREDITS" |
| 573 |
"Social Contract about Contributed Modules" originally by Russ Allbery <[email protected]> and the perl5\-porters. |