X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=CONTRIBUTING;h=97c118096d9e73788f51b01d22fea9d9a8ce167f;hb=b4e13e80559c593090627eac9c828018223bb8f8;hp=c37d76f9e3e43eb50f815336aa61927528a32e62;hpb=e40eb4d893968e6aada17d137cc43e698394c684;p=p5sagit%2FDevel-REPL.git diff --git a/CONTRIBUTING b/CONTRIBUTING index c37d76f..97c1180 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -4,6 +4,16 @@ CONTRIBUTING Thank you for considering contributing to this distribution. This file contains instructions that will help you work with the source code. +PLEASE NOTE that if you have any questions or difficulties, you can reach the +maintainer(s) through the bug queue described later in this document +(preferred), or by emailing the releaser directly. You are not required to +follow any of the steps in this document to submit a patch or bug report; +these are just recommendations, intended to help you (and help us help you +faster). + +This distribution has a TODO file in the repository; you may want to check +there to see if your issue or patch idea is mentioned. + The distribution is managed with Dist::Zilla (https://metacpan.org/release/Dist-Zilla). This means than many of the usual files you might expect are not in the repository, but are generated at release time (e.g. Makefile.PL). @@ -19,7 +29,7 @@ patches you have. You may need to satisfy some dependencies. The easiest way to satisfy dependencies is to install the last release -- this is available at -https://metacpan.org/release/Devel-REPL. +https://metacpan.org/release/Devel-REPL If you use cpanminus, you can do it without downloading the tarball first: @@ -64,13 +74,28 @@ Once installed, here are some dzil commands you might try: You can learn more about Dist::Zilla at http://dzil.org/. +The code for this distribution is hosted at GitHub. The repository is: +https://github.com/p5sagit/Devel-REPL +You can submit code changes by forking the repository, pushing your code +changes to your clone, and then submitting a pull request. Detailed +instructions for doing that is available here: + +https://help.github.com/articles/creating-a-pull-request If you have found a bug, but do not have an accompanying patch to fix it, you can submit an issue report here: https://rt.cpan.org/Public/Dist/Display.html?Name=Devel-REPL -or via bug-Devel-REPL@rt.cpan.org. -This is a good place to send your questions about the usage of this distribution. +or via email: bug-Devel-REPL@rt.cpan.org + +There is also an irc channel available for users of this distribution, at +irc://irc.perl.org/#devel-repl + +If you send me a patch or pull request, your name and email address will be +included in the documentation as a contributor (using the attribution on the +commit or patch), unless you specifically request for it not to be. If you +wish to be listed under a different name or address, you should submit a pull +request to the .mailmap file to contain the correct mapping. -This file was generated via Dist::Zilla::Plugin::GenerateFile::ShareDir 0.005 from a -template file originating in Dist-Zilla-PluginBundle-Author-ETHER-0.065. +This file was generated via Dist::Zilla::Plugin::GenerateFile::FromShareDir 0.009 from a +template file originating in Dist-Zilla-PluginBundle-Author-ETHER-0.111.