Akelos source-code repository, development wiki and bug-report system

Akelos is available open-source under the LGPL license.

Browsing Akelos's codebase online

Getting involved

Documentation Efforts

Being a port of Ruby on Rails to PHP most of existing documents can be easily adapted Akelos, the API documentation is a good example.

You can help by submitting Documentation Tickets if you:

Checking out the source

The Subversion repository resides at http://svn.akelos.org/

Check out the current development trunk with:

svn co http://svn.akelos.org/trunk akelos

Creating a patch

Tickets are fine, but patches are great. If you want to modify Akelos or fix a bug you've run across, there's no faster way to make it happen than to do it yourself. Akelos thrives on the generous work of contributors from around the world. Please become one of them.

  1. Get Akelos ready for patching
    1. Check out the latest source: svn co http://svn.akelos.org/trunk
    2. Ensure that the existing unit tests pass.
  2. Make a test-driven change
    1. Add or change unit tests to prove that your change works.
    2. Make the change to the source.
    3. Verify that all tests pass by running ./script/test unit.
  3. Share your well-tested change
    1. Sanity check the changes you've made: svn status
    2. Create a patch: svn diff > my_descriptively_named_patch.diff
    3. Login to Trac or register a new user.
    4. Create a new ticket with [PATCH] as the first word in the summary. Attach your patch file.
    5. Keep an eye on the ticket and address concerns that arise. Make your change hard not to commit.
    6. Expect your ticket to be closed with an untested, undocumented, or incomplete resolution if it's missing tests, documentation, or implementation. Don't panic; the ticket hasn't been killed! These resolutions are the pathway to commit. Update your patch and reopen the ticket.
  4. Bask in the glory of being an Akelos contributor!

Source style

  • Edit source code files using UTF-8.
  • Four spaces, no tabs.
  • Don't use and and or for boolean tests, instead always use && and ||
  • MyClass->myMethod($my_arg) -- not my_method( $my_arg ) or MyMethod($myArg)
  • Follow the conventions you see used in the source already
  • Have a look at Akelos Framework coding guidelines before writing new functionality for Akelos

Ticket Log mailing list

You can join the mailing list for keeping an eye on tickets