X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=p5sagit%2FSub-Name.git;a=blobdiff_plain;f=CONTRIBUTING;h=a486e89f40f7c9c92d0e91f208c32eb51b2d9707;hp=20ca5cbf425fb6c211caa9e2e5e4db14228f43ec;hb=HEAD;hpb=67523925ccdb8365504f86d34570e2cc5e8847a0 diff --git a/CONTRIBUTING b/CONTRIBUTING index 20ca5cb..a486e89 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -4,10 +4,15 @@ 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 me -through the bug queue described later in this document, or by emailing me -directly. You are not required to follow any of the steps in this document to -submit a patch or bug report; these are just guidelines, intended to help you. +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). However, you can still compile and test the code with a small Makefile.PL @@ -25,7 +30,7 @@ or 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/Sub-Name. +https://metacpan.org/release/Sub-Name If you use cpanminus, you can do it without downloading the tarball first: @@ -71,26 +76,34 @@ 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/karenetheridge/Sub-Name +https://github.com/p5sagit/Sub-Name 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: +changes to your clone, and then submitting a pull request. Please include a +suitable end-user-oriented entry in the Changes file describing your change. +Detailed instructions for doing that is available here: -https://help.github.com/ https://help.github.com/articles/creating-a-pull-request +All pull requests for this distribution will be automatically tested on Linux +by Travis at: https://travis-ci.com/p5sagit/Sub-Name +Results will be visible in the pull request on GitHub. Follow the appropriate +links for details when tests fail. Changes will not be mergeable until all +tests pass. + 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=Sub-Name -or via bug-Sub-Name@rt.cpan.org. -This is a good place to send your questions about the usage of this distribution. +or via email: bug-Sub-Name@rt.cpan.org + +There is also an irc channel available for users of this distribution, at +irc://irc.perl.org/#toolchain If you send me a patch or pull request, your name and email address will be -included in the documentation as a contributor, unless you specifically -request for it not to be (using the attribution on the commit or patch). -If you wish to be listed under a different name, you should submit a pull +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.069. +This file was generated via Dist::Zilla::Plugin::GenerateFile::FromShareDir 0.014 +from a template file originating in Dist-Zilla-PluginBundle-Author-ETHER-0.150.