[prev] [thread] [next] [lurker] [Date index for 2002/09/25]
Update of /cvsroot/siesta/siesta In directory usw-pr-cvs1:/tmp/cvs-serv2238 Added Files: HACKING Log Message: first run --- NEW FILE: HACKING --- # This document is written in pod. To read it without the funny # formatting use perldoc HACKING =head1 NAME HACKING - a quick guide to coding on Siesta =head1 DESCRIPTION So you want to contribute to Siesta? Excellent, step this way. =head1 Getting Started The first things you'll want to do are to subscribe to our mailing lists, get a copy of the latest code from CVS, read that code, and the rest of this document. =head2 Subscribe to the mailing lists. There are currently 3 lists dedicated to the development of Siesta. =over =item siesta-users Where issues with usage and feature requests happen. =item siesta-dev Where the coordination of the main development happens. =item siesta-commit Where CVS commit messages go. This is worth reading to see in what direction the code is moving. =back To subscribe to any of these send email to C<I<listname>-sub@unixbeard.net> and follow the instructions you get back. =head2 Get a copy of the latest sources cvs -d:pserver:anonymous@xxx.xxxxxx.xx.xxx:/cvsroot/siesta co siesta =head2 Read the sources XXX explain the structure of the code layout a little =head2 Read the rest of this document I know you're impatient to get going, but please follow through this through first. =head1 Important conventions These are only important because not keeping to them annoys richardc, and when that happens things tend to get defenestrated. We like to keep that to a minimum. =head2 do TODO list items first XXX =head2 Code layout Since the dawn of time this argument has been running. Thankfully these years of fighting have allowed a solution to evolve - L<perltidy.|http://perltidy.sf.net/>; The mandated set of arguments to perltidy are encoded in the script C<bin/run_perltidy>. For convenience there is a Makefile target which invokes it, so after hacking, and before generating your patch, run: make perltidy And no-one gets hurt. =head2 Testing Tests will put hair on your chest and 20 years on your life, or maybe that was Ready-Brek. Either way we have a test suite, and it is expected that your new contributions will bolster and not break any existing tests. make test Also it'd be nice if you can bear in mind test coverage. We have a target that runs the testsuite using L<Devel::Cover>, so install that and periodically run: make cover =head2 patch format Unified diffs are preferred, unified diffs produced from the top of a CVS tree doubly so. To produce these simply run this command in the top level directory. cvs diff -up =head1 AUTHOR Richard Clamp <richardc@xxxxxxxxx.xxx> =head1 COPYRIGHT Copyright (c) 2002, Richard Clamp. All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself. =cut
Generated at 13:57 on 01 Jul 2004 by mariachi 0.52