| 1 |
NAME |
| 2 |
CONTRIBUTING |
| 3 |
|
| 4 |
DESCRIPTION |
| 5 |
If you're reading this document, that means you might be thinking about |
| 6 |
helping me out with this project. Thanks! |
| 7 |
|
| 8 |
Here's some ways you could help out: |
| 9 |
|
| 10 |
* Bug reports |
| 11 |
|
| 12 |
Found a bug? Great! (Well, not so great I suppose.) |
| 13 |
|
| 14 |
The place to report them is <https://rt.cpan.org/>. Don't e-mail me |
| 15 |
about it, as your e-mail is more than likely to get lost amongst the |
| 16 |
spam. |
| 17 |
|
| 18 |
An example script clearly demonstrating the bug (preferably written |
| 19 |
using Test::More) would be greatly appreciated. |
| 20 |
|
| 21 |
* Patches |
| 22 |
|
| 23 |
If you've found a bug and written a fix for it, even better! |
| 24 |
|
| 25 |
Generally speaking you should check out the latest copy of the code |
| 26 |
from the source repository rather than using the CPAN distribution. |
| 27 |
The file META.yml should contain a link to the source repository. If |
| 28 |
not, then try <https://github.com/tobyink> or submit a bug report. |
| 29 |
(As far as I'm concerned the lack of a link is a bug.) Many of my |
| 30 |
distributions are also mirrored at <https://bitbucket.org/tobyink>. |
| 31 |
|
| 32 |
To submit the patch, do a pull request on GitHub or Bitbucket, or |
| 33 |
attach a diff file to a bug report. Unless otherwise stated, I'll |
| 34 |
assume that your contributions are licensed under the same terms as |
| 35 |
the rest of the project. |
| 36 |
|
| 37 |
(If using git, feel free to work in a branch. For Mercurial, I'd |
| 38 |
prefer bookmarks within the default branch.) |
| 39 |
|
| 40 |
* Documentation |
| 41 |
|
| 42 |
If there's anything unclear in the documentation, please submit this |
| 43 |
as a bug report or patch as above. |
| 44 |
|
| 45 |
Non-toy example scripts that I can bundle would also be appreciated. |
| 46 |
|
| 47 |
* Translation |
| 48 |
|
| 49 |
Translations of documentation would be welcome. |
| 50 |
|
| 51 |
For translations of error messages and other strings embedded in the |
| 52 |
code, check with me first. Sometimes the English strings may not in |
| 53 |
a stable state, so it would be a waste of time translating them. |
| 54 |
|
| 55 |
Coding Style |
| 56 |
I tend to write using something approximating the Allman style, using |
| 57 |
tabs for indentation and Unix-style line breaks. |
| 58 |
|
| 59 |
* <http://en.wikipedia.org/wiki/Indent_style#Allman_style> |
| 60 |
|
| 61 |
* <http://www.derkarl.org/why_to_tabs.html> |
| 62 |
|
| 63 |
I nominally encode all source files as UTF-8, though in practice most of |
| 64 |
them use a 7-bit-safe ASCII-compatible subset of UTF-8. |
| 65 |
|
| 66 |
AUTHOR |
| 67 |
Toby Inkster <[email protected]>. |
| 68 |
|
| 69 |
COPYRIGHT AND LICENCE |
| 70 |
Copyright (c) 2012-2014 by Toby Inkster. |
| 71 |
|
| 72 |
CONTRIBUTING is available under three different licences permitting its |
| 73 |
redistribution: the CC-BY-SA_UK-2.0 licence, plus the same licences as |
| 74 |
Perl itself, which is distributed under the GNU General Public Licence |
| 75 |
version 1, and the Artistic Licence. |
| 76 |
|
| 77 |
This file is licensed under the Creative Commons Attribution-ShareAlike |
| 78 |
2.0 UK: England & Wales License. To view a copy of this license, visit |
| 79 |
<http://creativecommons.org/licenses/by-sa/2.0/uk/>. |
| 80 |
|
| 81 |
This file is free software; you can redistribute it and/or modify it |
| 82 |
under the same terms as the Perl 5 programming language system itself. |
| 83 |
|