Contributing

IPC::Open3::Callback uses standard perl conventions as well as a few items outlined in Damian Conway's Perl Best Practices. The build tool used is Dist::Zilla (dist.ini). Code formatting is handled by perltidy (xt/.perltidyrc). And documentation is generated by Pod::Weaver (weaver.ini).

Dist::Zilla

Dist::Zilla handles the entire build lifecycle as well as many other tasks like running unit tests, and perltidy. Before checking any code in, dzil perltidy and dzil test should be run in order to ensure proper code formatting and code validity.

Pod::Weaver

Pod::Weaver simplifies pod syntax and generates various sections based upon other project configuration. It uses non-standard pod syntax interwoven with standard pod syntax so take care to use the proper syntax for the proper situation.

git

To contribute, it is recommended that you fork this project, clone the fork, add an upstream remote, and then fetch and merge from both before committing. This article covers some of the details.