1 2CONTRIBUTING 3 4Thank you for considering contributing to this distribution. This file 5contains instructions that will help you work with the source code. 6 7PLEASE NOTE that if you have any questions or difficulties, you can reach the 8maintainer(s) through the bug queue described later in this document 9(preferred), or by emailing the releaser directly. You are not required to 10follow any of the steps in this document to submit a patch or bug report; 11these are just recommendations, intended to help you (and help us help you 12faster). 13 14The distribution is managed with Dist::Zilla (https://metacpan.org/release/Dist-Zilla). 15This means than many of the usual files you might expect are not in the 16repository, but are generated at release time (e.g. Makefile.PL). 17 18However, you can run tests directly using the 'prove' tool: 19 20 $ prove -l 21 $ prove -lv t/some_test_file.t 22 $ prove -lvr t/ 23 24In most cases, 'prove' is entirely sufficent for you to test any 25patches you have. 26 27You may need to satisfy some dependencies. The easiest way to satisfy 28dependencies is to install the last release -- this is available at 29https://metacpan.org/release/MooseX-Types-DateTime. 30 31If you use cpanminus, you can do it without downloading the tarball first: 32 33 $ cpanm --reinstall --installdeps --with-recommends MooseX::Types::DateTime 34 35Dist::Zilla is a very powerful authoring tool, but requires a number of 36author-specific plugins. If you would like to use it for contributing, 37install it from CPAN, then run one of the following commands, depending on 38your CPAN client: 39 40 $ cpan `dzil authordeps --missing` 41or 42 $ dzil authordeps --missing | cpanm 43 44You should then also install any additional requirements not needed by the 45dzil build but may be needed by tests or other development: 46 47 $ cpan `dzil listdeps --author --missing` 48or 49 $ dzil listdeps --author --missing | cpanm 50 51Or, you can use the 'dzil stale' command to install all requirements at once: 52 53 $ cpan Dist::Zilla::App::Command::stale 54 $ cpan `dzil stale --all` 55or 56 $ cpanm Dist::Zilla::App::Command::stale 57 $ dzil stale --all | cpanm 58 59You can also do this via cpanm directly: 60 61 $ cpanm --reinstall --installdeps --with-develop --with-recommends MooseX::Types::DateTime 62 63Once installed, here are some dzil commands you might try: 64 65 $ dzil build 66 $ dzil test 67 $ dzil test --release 68 $ dzil xtest 69 $ dzil listdeps --json 70 $ dzil build --notgz 71 72You can learn more about Dist::Zilla at http://dzil.org/. 73 74The code for this distribution is hosted at GitHub. The repository is: 75https://github.com/moose/MooseX-Types-DateTime 76You can submit code changes by forking the repository, pushing your code 77changes to your clone, and then submitting a pull request. Detailed 78instructions for doing that is available here: 79 80https://help.github.com/articles/creating-a-pull-request 81 82If you have found a bug, but do not have an accompanying patch to fix it, you 83can submit an issue report here: 84https://rt.cpan.org/Public/Dist/Display.html?Name=MooseX-Types-DateTime 85or via bug-MooseX-Types-DateTime@rt.cpan.org. 86 87There is also a mailing list available for users of this distribution, at 88http://lists.perl.org/list/moose.html. 89There is also an irc channel available for users of this distribution, at 90irc://irc.perl.org/#moose. 91 92If you send me a patch or pull request, your name and email address will be 93included in the documentation as a contributor (using the attribution on the 94commit or patch), unless you specifically request for it not to be. If you 95wish to be listed under a different name or address, you should submit a pull 96request to the .mailmap file to contain the correct mapping. 97 98 99This file was generated via Dist::Zilla::Plugin::GenerateFile::ShareDir 0.006 from a 100template file originating in Dist-Zilla-PluginBundle-Author-ETHER-0.105. 101