lib/Moose/Manual/Support.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 Moose::Manual::Support - Policies regarding support, releases, and
   6 compatibility.
   7
   8 =head1 SUPPORT POLICY
   9
  10 There are two principles to Moose's policy of supported behavior.
  11
  12 =over 4
  13
  14 =item 1.
  15
  16 Moose favors correctness over everything.
  17
  18 =item 2.
  19
  20 Moose supports documented and tested behavior, not accidental behavior or side
  21 effects.
  22
  23 =back
  24
  25 If a behavior has never been documented or tested, the behavior is
  26 I<officially> undefined. Relying upon undocumented and untested behavior is
  27 done at your own risk.
  28
  29 If a behavior is documented or tested but found to be incorrect later, the
  30 behavior will go through a deprecation period. During the deprecation period,
  31 use of that feature will cause a warning. Eventually, the deprecated feature
  32 will be removed.
  33
  34 =head1 RELEASE SCHEDULE
  35
  36 Moose is on a system of weekly minor releases and quarterly major releases. A
  37 minor release is defined as one that makes every attempt to preserve backwards
  38 compatibility. Currently this means that we did not introduce any new
  39 dependency conflicts, and that we did not make any changes to documented,
  40 tested behavior. A minor release can include new features and bug fixes.
  41
  42 Major releases may be backwards incompatible. Moose prioritizes
  43 correctness over backwards compatibility or performance; see the L<Deprecation
  44 Policy> to understand how backwards incompatible changes are announced.
  45
  46 Before a major release, a series of development releases will be made so that
  47 users can test the upcoming major release before it is distributed to CPAN. It
  48 is in the best interests of everyone involved if these releases are tested as
  49 widely as possible.
  50
  51 =head1 DEPRECATION POLICY
  52
  53 Moose has always prioritized correctness over performance and backwards
  54 compatibility.
  55
  56 Major deprecations or API changes are documented in the Changes file as well
  57 as in L<Moose::Manual::Delta>. The Moose developers will also make an effort
  58 to warn users of upcoming deprecations and breakage through the Moose blog
  59 (http://blog.moose.perl.org).
  60
  61 Deprecated APIs will be preserved for at least one year, and will only be
  62 removed in a major release.
  63
  64 Moose will also warn during installation if the version of Moose being
  65 installed will break an installed dependency. Unfortunately, due to the nature
  66 of the Perl install process these warnings may be easy to miss.
  67
  68 =head1 BACKWARDS COMPATIBILITY
  69
  70 We try to ensure compatibility by having a extensive test suite (last
  71 count just over around 5123 tests), as well as testing a number of
  72 packages (currently just under 100 packages) that depend on Moose before
  73 any release.
  74
  75 The current list of downstream dependencies that are tested is in
  76 C<xt/author/test-my-dependents.t>.
  77
  78 =head1 VERSION NUMBERS
  79
  80 Moose version numbers consist of three parts, in the form X.YYZZ. The X is the
  81 "special magic number" that only gets changed for really big changes. Think of
  82 this as being like the "5" in Perl 5.12.1.
  83
  84 The YY portion is the major version number. Moose uses even numbers for stable
  85 releases, and odd numbers for trial releases. The ZZ is the minor version, and
  86 it simply increases monotonically. It starts at "00" each time a new major
  87 version is released.
  88
  89 Semantically, this means that any two releases which share a major version
  90 should be API-compatible with each other. In other words, 2.0200, 2.0201, and
  91 2.0274 are all API-compatible.
  92
  93 Prior to version 2.0, Moose version numbers were monotonically incrementing
  94 two decimal values (0.01, 0.02, ... 1.11, 1.12, etc.).
  95
  96 Moose was declared production ready at version 0.18 (via L<<
  97 http://www.perlmonks.org/?node_id=608144 >>).
  98
  99 =head1 CONTRIBUTING
 100
 101 Moose has an open contribution policy. Anybody is welcome to submit a
 102 patch. Please see L<Moose::Manual::Contributing> for more details.
 103
 104 =cut