Showing your love for Akelos
Lets face it, Akelos is not as popular as Rails. Way too many PHP Frameworks are competing for getting quality contributors.
We already have some of the best contributors and responsive community members, but we still need to spread the word to get more help to grow Akelos.
Show your love for Akelos on your blog, giving credit on your apps with a simple
made with Akelos, the best <a href="http://www.akelos.org">PHP Framework</a>
by telling your collegues, proposing Akelos for your next project, advocating in public conferences or voting for Akelos on one of these sites
Contributing to the wikis
- The Akelos Community documentation wiki, is the place for user contributions to the documentation and the Akelos knowledge sphere. Adapting free documentation from the Ruby on Rails wiki can be a simple and fun way to understand better Akelos while improving the documentation.
- Core Development Wiki, mainly for tracing plans about the development roadmap, continuous integration settings, core unit testing, release management and core framework principles.
Submitting Documentation Tickets.
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 submit a documentation ticket at the development site,
- when you find a typo or a problem,
- for documenting undocumented features or
- if you feel like updating inline documentation with the [http://dev.rubyonrails.org/report/20 improvements already committed into Rails].
Report, work on, and resolve issues in the development site
The development site is the place to submit issues of all types. This includes bugs, change requests, feature requests, and small patches.
The development site is also the place to track the release roadmap and view the current status of the framework.
Review Subversion commits
As code comes into Subversion, it is displayed in our source code browser with the changesets listed with full diffs. Review commits and double-check the work of others—the more eyes, the better. This is also a great way to get a feel for the framework coding style and culture.
Contribute Code
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
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.
- Get Akelos ready for patching
- Check out the latest source: svn co http://svn.akelos.org/trunk
- Ensure that the existing unit tests pass.
- Make a test-driven change
- Add or change unit tests to prove that your change works.
- Make the change to the source.
- Verify that all tests pass by running ./script/test unit.
- Share your well-tested change
- Sanity check the changes you've made: svn status
- Create a patch: svn diff > mydescriptivelynamed_patch.diff
- Login to Trac or register a new user.
- Create a new ticket with [PATCH] as the first word in the summary. Attach your patch file.
- Keep an eye on the ticket and address concerns that arise. Make your change hard not to commit.
- 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.
- 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
