CONTRIBUTING

   1 Contributing guildelines for the Variable-Magic distribution
   2
   3 Patch submissions guidelines :
   4 - Patches VERY MUCH SHOULD be generated with "git format-patch".
   5     If that's really not possible, make sure your patches apply cleanly in the
   6     distribution directory.
   7 - Single patches MUST be submitted to the bugtracker.
   8     Open a ticket and add your patch as an attachment.
   9 - Series of patches CAN be submitted as a public feature branch.
  10     You can clone the directory wherever you want and point me to your remote
  11     branch as long as I don't need to log in.
  12
  13 C/XS-related guidelines :
  14 - C code MUST be kept ANSI-compliant.
  15     Older perl versions may have been built with a C compiler that does not
  16     support C99 features (plus they are mostly useless except for restrict).
  17     In particular, this means no C99 comments, no mixed declaration and code,
  18     and no C++ void* casts.
  19 - XS code MUST be buildable with any perl matching the META requirements.
  20     If needed, wrap your code around with the XSH_HAS_PERL(x, y, z) macro.
  21
  22 Tests-related guidelines :
  23 - Patches MUST be tested before being sent.
  24     Make sure the distribution builds and tests correctly.
  25 - Patches that add version-specific code MUST be tested with at least
  26   one perl release matching each version interval.
  27     That is, if you add new code specific to perl 5.34 and above, then you
  28     have to test it with a pre-5.34 perl (e.g. 5.32) and a post-5.34 perl
  29     (e.g. 5.34).
  30 - C/XS patches MUST be tested with a threaded perl regardless of how much you
  31   dislike perl threads.
  32     Testing with a threaded perl makes sure your code can build in many more
  33     situations. Memory issues are also more easily spotted.
  34 - Bugfixes SHOULD come with a regression test.
  35     Add it to an existing .t file or create your own.
  36
  37 What you don't need to do :
  38 - DON'T update the Changes file.
  39 - DON'T run author tests.