Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 446f243
Showing
6 changed files
with
312 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
.build | ||
*.swp | ||
*.tar.gz | ||
.DS_Store | ||
/Mojolicious-Broker-* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
language: perl | ||
perl: | ||
- "5.8" | ||
- "5.10" | ||
- "5.12" | ||
- "5.14" | ||
- "5.16" | ||
- "5.18" | ||
- "5.20" | ||
- "5.22" | ||
- "blead" | ||
|
||
matrix: | ||
include: | ||
- perl: "5.20" | ||
env: COVERAGE=1 | ||
allow_failures: | ||
- perl: "blead" | ||
|
||
before_install: | ||
- git clone git://github.com/travis-perl/helpers ~/travis-perl-helpers | ||
- source ~/travis-perl-helpers/init | ||
- build-perl | ||
- perl -V | ||
- build-dist | ||
- cd $BUILD_DIR | ||
|
||
install: | ||
- cpan-install --deps | ||
- cpan-install --coverage | ||
|
||
before_script: | ||
- coverage-setup | ||
|
||
script: | ||
- perl Makefile.PL | ||
- make | ||
- prove -bl -s -j$(test-jobs) $(test-files) | ||
|
||
after_success: | ||
- coverage-report |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,118 @@ | ||
# CONTRIBUTING | ||
|
||
This project is free software for the express purpose of collaboration. | ||
We welcome all input, bug reports, feature requests, general comments, | ||
and patches. | ||
|
||
If you're not sure about anything, please open an issue and ask! | ||
|
||
## Standard of Conduct | ||
|
||
To ensure a welcoming, safe, collaborative environment, this project | ||
will enforce a standard of conduct: | ||
|
||
* The topic of this project is the project itself. Please stay on-topic. | ||
* Stick to the facts | ||
* Avoid demeaning remarks and sarcasm | ||
|
||
Unacceptable behavior will receive a single, public warning. Repeated | ||
unacceptable behavior will result in removal from the project. | ||
|
||
Remember, all the people who contribute to this project are volunteers. | ||
|
||
### Please Try to Avoid | ||
|
||
This behavior is not against the standard of conduct, but following | ||
these guidelines will make it easier to manage the project. | ||
|
||
* Comments with only '+1' | ||
* Every open issue will be addressed. | ||
|
||
## What to Contribute | ||
|
||
### Comments | ||
|
||
The issue tracker is used for both bug reports and to-do list. Anything | ||
on the issue tracker, open or closed, is available for discussion. | ||
|
||
### Fixes | ||
|
||
For fixes, simply fork and send a pull request. Be sure to add yourself | ||
to the dist.ini as an author! | ||
|
||
Fixes to anything, documentation, code, tests, are equally welcome, | ||
appreciated, and addressed! | ||
|
||
### Features | ||
|
||
All contributions are welcome if they fit the scope of this project. If | ||
you're not sure if your feature fits, open an issue and ask. If it doesn't | ||
fit, we will try to find a way to enable you to add your feature in a | ||
related project (if it means changes in this project). | ||
|
||
## Before you Contribute | ||
|
||
### Copyright and License | ||
|
||
All contributions are copyright their respective owners, so make sure you | ||
agree with the project license (found in the LICENSE file) before | ||
contributing. | ||
|
||
Make sure to add yourself as an author to either the AUTHORS file or | ||
the dist.ini file so you get your proper copyright attribution. | ||
|
||
### Formatting and Syntax | ||
|
||
I don't worry too much about this, yet. I'm sure I'll fill this section | ||
in a bit more. For now, try to match as best you can the code that | ||
already exists in this project. | ||
|
||
## How to Contribute | ||
|
||
This project uses Dist::Zilla for its releases, but you aren't required | ||
to use it for contributing. | ||
|
||
### Using Build.PL | ||
|
||
This is the easiest way that requires the fewest dependencies. | ||
|
||
Install the project's dependencies and run the tests by doing: | ||
|
||
``` | ||
perl Build.PL | ||
./Build installdeps | ||
./Build test | ||
``` | ||
|
||
### Using Makefile.PL | ||
|
||
This is the older standard way. If you can install CPAN modules, you can | ||
probably do this. It requires `make` and maybe a C compiler. | ||
|
||
Run the tests by doing: | ||
|
||
``` | ||
perl Makefile.PL | ||
make test | ||
``` | ||
|
||
Install the module's dependencies by doing: | ||
|
||
``` | ||
cpanm . | ||
``` | ||
|
||
### Using Dist::Zilla | ||
|
||
Once you have installed Dist::Zilla, you can get this distributions's | ||
dependencies by doing: | ||
|
||
``` | ||
dzil listdeps --author --missing | cpanm | ||
``` | ||
|
||
Once all that is done, testing is as easy as: | ||
|
||
``` | ||
dzil test | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,107 @@ | ||
|
||
; --- Project details | ||
name = Mojolicious-Broker | ||
author = Doug Bell <preaction@cpan.org> | ||
license = Perl_5 | ||
copyright_holder = Doug Bell | ||
copyright_year = 2015 | ||
|
||
[Authority] | ||
authority = cpan:PREACTION | ||
do_munging = 0 | ||
|
||
[MetaResources] | ||
homepage = https://github.com/preaction/Mojolicious-Broker | ||
repository.web = https://github.com/preaction/Mojolicious-Broker | ||
repository.url = https://github.com/preaction/Mojolicious-Broker.git | ||
bugtracker.web = https://github.com/preaction/Mojolicious-Broker/issues | ||
repository.type = git | ||
|
||
; --- Module management | ||
[@Filter] | ||
-bundle = @Basic | ||
; GatherDir must be configured separately | ||
-remove = GatherDir | ||
|
||
[ReadmeFromPod] | ||
[ReadmeMarkdownFromPod] | ||
[PodWeaver] | ||
[PkgVersion] | ||
[CPANFile] | ||
[Git::Contributors] | ||
; authordep Pod::Weaver::Section::Contributors | ||
[Test::ReportPrereqs] | ||
[Test::Compile] | ||
|
||
; --- Repository management | ||
[Git::GatherDir] | ||
include_dotfiles = 1 | ||
prune_directory = ^eg | ||
; Exclude dotfiles in the root directory | ||
exclude_match = ^\.[^/]+$ | ||
; Exclude ini files in the root directory | ||
exclude_match = ^[^/]+\.ini$ | ||
; Exclude generated root content, which is included by the various plugins | ||
; Without this, we get an error about duplicate content | ||
exclude_filename = cpanfile | ||
exclude_filename = INSTALL | ||
exclude_filename = LICENSE | ||
exclude_filename = CHANGES | ||
exclude_filename = README | ||
exclude_filename = README.mkdn | ||
exclude_filename = Build.PL | ||
exclude_filename = Makefile.PL | ||
|
||
[ChangelogFromGit::CPAN::Changes] | ||
; Create a changelog from the git repository commits | ||
; The changelog will contain the short description of the change | ||
file_name = CHANGES | ||
show_author = 0 | ||
|
||
[Run::AfterBuild] | ||
; Add travis and coveralls badges to README.mkdn | ||
run = perl -pi -e 's{(# SYNOPSIS)}{# STATUS\n\n<a href="https://travis-ci.org/preaction/Mojolicious-Broker"><img src="https://travis-ci.org/preaction/Mojolicious-Broker.svg?branch=master"></a><a href="https://coveralls.io/r/preaction/Mojolicious-Broker"><img src="https://coveralls.io/repos/preaction/Mojolicious-Broker/badge.png" alt="Coverage Status" /></a>\n\n$1}' %d/README.mkdn | ||
|
||
[CopyFilesFromBuild] | ||
; Copy generated content to the repository root so users without Dist::Zilla | ||
; can use it | ||
copy = cpanfile | ||
copy = INSTALL | ||
copy = LICENSE | ||
copy = CHANGES | ||
copy = README | ||
copy = README.mkdn | ||
copy = Build.PL | ||
copy = Makefile.PL | ||
|
||
; --- Git management | ||
[Git::NextVersion] | ||
[@Git] | ||
; Automatically commit these files during release | ||
changelog = CHANGES | ||
allow_dirty_match = README.* | ||
allow_dirty_match = .*[.]PL | ||
allow_dirty = INSTALL | ||
allow_dirty = LICENSE | ||
allow_dirty = CHANGES | ||
allow_dirty = cpanfile | ||
; Automatically commit with release version and changelog | ||
commit_msg = release v%v%n%n%c | ||
tag_message = %N v%v - %{yyyy-MM-dd}d%n%n%c ; Tag annotations show up in github release list | ||
|
||
; --- Project-specific directives | ||
|
||
[Prereqs] | ||
perl = 5.008 | ||
|
||
;-- Common prereqs with minimum version requirements | ||
;Path::Tiny = 0.072 ; Fixes issues with File::Path | ||
;List::Util = 1.29 ; First version with pair* functions | ||
;Getopt::Long = 2.36 ; First version with GetOptionsFromArray | ||
;Import::Base = 0.012 ; Fixed using subs in imports | ||
|
||
[Prereqs / TestRequires] | ||
Test::More = 1.001005 ; First version that allows args to subtests | ||
Test::Deep = 0 | ||
Test::Differences = 0 | ||
Test::Exception = 0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
package Mojolicious::Broker; | ||
# ABSTRACT: Write a sentence about what it does | ||
|
||
use strict; | ||
use warnings; | ||
|
||
|
||
|
||
1; | ||
__END__ | ||
=head1 SYNOPSIS | ||
=head1 DESCRIPTION | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
[@CorePrep] | ||
|
||
[Name] | ||
[Version] | ||
|
||
[Region / prelude] | ||
|
||
[Generic / SYNOPSIS] | ||
[Generic / DESCRIPTION] | ||
[Generic / RATIONALE] | ||
[Generic / QUICKSTART] | ||
[Generic / OVERVIEW] | ||
|
||
[Collect / ATTRIBUTES] | ||
command = attr | ||
[Collect / METHODS] | ||
command = method | ||
[Collect / SUBROUTINES] | ||
command = sub | ||
|
||
[Leftovers] | ||
|
||
[Region / postlude] | ||
|
||
[Authors] | ||
[Legal] |