NAME

Mojo::Manual::CodingGuidelines - Coding Guidelines

OVERVIEW

This document describes the coding guidelines that are the foundations of Mojo development.

Please don't send patches unless you agree with them.

MISSION STATEMENT

Mojo is a Perl web framework that provides all the basic tools and helpers needed to write simple web applications and higher level web frameworks.

All components should be reusable in other projects and in a UNIXish way only loosely coupled.

Especially for people new to Perl it should be as easy as possible to install Mojo and get started. Writing web applications can be one of the most fun ways to learn a language!

For other framework developers it should be possible to reuse all the infrastructure and just consider the higher levels of Mojo an example application.

RULES

Keep it simple, no magic unless absolutely neccessary.

Code should be written with a Perl6 port in mind.

No refactoring unless a very important feature absolutely depends on it.

It's not a feature without a test.

A feature is only needed when the majority of the userbase benefits from it.

Features may not be changed without being deprecated for at least one major release.

Deprecating a feature should be avoided at all costs.

Only add prereqs if absolutely neccessary.

Domain specific languages should be avoided in favor of Perl'ish solutions.

No inline POD.

Documentation belongs to the manual, module POD is just a api reference.

Lines should not be longer than 78 characters and we indent with 4 whitespaces.

No spaghettie code.

Code should be organized in blocks and those blocks should be commented.

Comments should be funny if possible.

No names outside of the CREDITS section of Mojo.pm.

No Elitism.

Peace!