/ 
Dancer2-0.02
River stage three • 164 direct dependents • 185 total dependents
/ Dancer2::Development

NAME

Dancer2::Development - Guide for developers interested in contributing to Dancer2

VERSION

version 0.02

DESCRIPTION

This guide has been written to help anyone interested in contributing to the development of Dancer2.

First of all - thank you for your interest in the project! It's the community of helpful contributors who've helped Dancer2 experience phenomenal growth to get to where it is today.

Please read this guide before contributing to Dancer2, to avoid wasted effort and maximizing the chances of your contributions being used.

WAYS TO CONTRIBUTE

There are many ways to contribute to the project. Dancer2 is a young yet active project and any kind of help is very much appreciated!

Publicity

You don't have to start by hacking the code, spreading the word is very valuable as well!

If you have a blog, just feel free to speak about Dancer2.

If you're a Twitter user, you can tweet about it with the hashtag #perl (and feel free to follow @PerlDancer for news and updates on Dancer2!).

Of course, it doesn't have to be limited to blogs or Twitter. Feel free to spread the word in whatever way you consider fit and drop us a line on the Dancer2 user mailing list noted below.

Also, if you're using and enjoying Dancer2, http://cpanratings.perl.org/dist/Dancer2, explaining what you like about Dancer2 is another very valuable contribution that helps other new users find us!

Mailing list / IRC community

Subscribing to the mailing list and/or hanging out on our IRC channel and providing assistance to new users is incredibly valuable.

Documentation

While we value documentation very much, it's difficult to keep it up-to-date. If you find a typo or an error in the documentation please do let us know - ideally by submitting a patch with your fix (see "Patch Submission").

Contribute to CPAN Testers

If you have access to perl on rare operating systems, please consider contributing tests. See http://wiki.cpantesters.org/wiki/TestDuringInstall for more information.

Code

You can write extensions (plugins) for Dancer2 extending Dancer2's core functionality or contribute to Dancer2's core code, see "Patch Submission" below.

GENERAL DEVELOPMENT GUIDELINES

This section lists high-level recommendations for developing Dancer2, for more detailed guidelines, see "Coding Guidelines" below.

Quality Assurance

Dancer2 should be able to install for all Perl versions since 5.8, on any platform for which Perl exists. We focus mainly on GNU/Linux (any distribution), *BSD and Windows (native and Cygwin).

We should avoid regressions as much as possible and keep backwards compatibility in mind when refactoring. Stable releases should not break functionality and new releases should provide an upgrade path and upgrade tips such as warning the user about deprecated functionality.

Quality Supervision

We can measure our quality using the CPAN testers platform: http://www.cpantesters.org.

A good way to help the project is to find a failing build log on the CPAN testers: http://www.cpantesters.org/distro/D/Dancer2.html

If you find a failing test report, feel free to report it as a GitHub issue: http://github.com/PerlDancer/Dancer2/issues.

Reporting Bugs

We prefer to have all our bug reports on GitHub, in the issues section: http://github.com/sukria/Dancer2/issues. It's possible though to report bugs on RT as well: https://rt.cpan.org/Dist/Display.html?Queue=Dancer2

Please make sure the bug you're reporting does not yet exist. In doubt please ask on IRC.

Patch Submission

The Dancer2 development team uses GitHub to collaborate. We greatly appreciate contributions submitted via GitHub, as it makes tracking these contributions and applying them much, much easier. This gives your contribution a much better chance of being integrated into Dancer2 quickly!

To help us achieve high-quality, stable releases, git-flow workflow is used to handle pull-requests, that means contributors must work on their devel branch rather than on their master. (Master should be touched only by the core dev team when preparing a release to CPAN; all ongoing development happens in branches which are merged to the devel branch.)

Here is the workflow for submitting a patch:

  • Fork the repository http://github.com/PerlDancer/Dancer2 (click "Fork")

  • Clone your fork to have a local copy using the following command:

    $ git clone git://github.com/myname/Dancer2.git

  • As a contributor, you should always work on the devel branch of your clone (master is used only for building releases).

    $ git remote add upstream https://github.com/sukria/Dancer2.git
$ git fetch upstream
$ git checkout -b devel upstream/devel

    This will create a local branch in your clone named devel and that will track the official devel branch. That way, if you have more or less commits than the upstream repo, you'll be immediately notified by git.

  • You want to isolate all your commits in a topic branch, this will make the reviewing much easier for the core team and will allow you to continue working on your clone without worrying about different commits mixing together.

    To do that, first create a local branch to build your pull request:

    # you should be in devel here
git checkout -b pr/$name

    Now you have created a local branch named pr/$name where $name is the name you want (it should describe the purpose of the pull request you're preparing).

    In that branch, do all the commits you need (the more the better) and when done, push the branch to your fork:

    # ... commits ...
git push origin pr/$name

    You are now ready to send a pull request.

  • Send a pull request via the GitHub interface. Make sure your pull request is based on the pr/$name branch you've just pushed, so that it incorporates the appropriate commits only.

    It's also a good idea to summarize your work in a report sent to the users mailing list (see below), in order to make sure the team is aware of it.

    You could also notify the core team on IRC, on irc.perl.org, channel #dancer or http://www.perldancer.org/irc.

  • When the core team reviews your pull request, it will either accept (and then merge into devel) or refuse your request.

    If it's refused, try to understand the reasons explained by the team for the denial. Most of the time, communicating with the core team is enough to understand what the mistake was. Above all, please don't be offended.

    If your pull-request is merged into devel, then all you have to do is to remove your local and remote pr/$name branch:

    git checkout devel
git branch -D pr/$name
git push origin :pr/$name

    And then, of course, you need to sync your local devel branch with the upstream:

    git pull upstream devel
git push origin devel

    You're now ready to start working on a new pull request!

RESOURCES FOR DEVELOPERS

Mailing Lists

A mailing list is available here: http://lists.perldancer.org/cgi-bin/listinfo/dancer-users

IRC Channels

You can reach the development team on irc.perl.org, channel #dancer or via a web chat interface at http://www.perldancer.org/irc. We're always happy to hear from users and contributors.

Repositories

The official repository is hosted on GitHub at the following location: http://github.com/PerlDancer/Dancer2.

Official developers have write access to this repository, contributors are invited to fork it if they want to submit patches, as explained in the Patch submission section.

AUTHOR

Dancer Core Developers

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Alexis Sukrieh.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

1 POD Error

The following errors were encountered while parsing the POD:

Around line 48:

alternative text 'http://cpanratings.perl.org/dist/Dancer2' contains non-escaped | or /