Contribute to Cyclone3
There are many ways you can directly contribute to the Cyclone3 projects even if you know nothing about Perl or XUL development. You can help us to improve documentation, provide usability feedback, sponsor development or simply share your ideas with developers.
Development of Cyclone3 is open to anyone willing to contribute to the Cyclone3 development so we can make Cyclone3 better for everyone. All development is done in a freely accessible subversion repository located at http://svn.cyclone3.org/.
We would like to thank you for even considering helping us to develop Cyclone3 and are looking forward to cooperate with you.
Where to Start?
We would like to invite you and everyone else interested in Cyclone3 to join our mailing list at cyclone3-devel@lists.sourceforge.net (just click the link and enter your e-mail). All development is discussed on this list so please stick to English only mail. Feel free to ask any questions here. If you prefer direct communication you can use our IRC channel #cyclone3 on irc.freenode.net. For detailed additional contacts please check out our contacts page.
We know that our documentation is far from complete so we encourage interested developers to study the code directly and ask other developers questions. We believe that the source code is easily understandable and well structured. Try to analyze some subsystem and play with it, when you understand it you can move forward to document it or try to improve it. If you end up with some improvements please post your patch to the mailing list and we will welcome you to the Cyclone3 project with commit access to subversion repository.
Cyclone3 consists of multiple subsystems and standalone projects. It is up to you to choose which one you want to contribute to. You don't have to develop new code and features, you can help us maintain older code by reformatting and documenting is so you will learn to understand Cyclone3 and pick up Perl development. We are interested in testers, new application developers of even thinkers with ideas which do not directly write any code. It is up to you how you decide to contribute - Any Help is Welcome.
Where you can contribute?
This section summarizes parts of the project that need attention and we would like you to help us with.
Cyclone3 Development
There are several documents which track current development of the project. This includes user request, bugs as well as new feature requests.
Organizing and Cleaning of Code.
This is a perfect way for new developers to pick up Perl or XUL programming. You are welcome to rewrite, clean up and comment any parts you are interested in.
You can check out the source and start playing with the code anytime you want. When you feel like you have something that we can use feel free to submit your patches or questions to the development mailing list. This is how you can learn to understand Cyclone3, Perl, XUL the practical way. If we consider you patches or feedback positive you can gain direct access to the subversion repository with full write access.
Writing Documentation
This is one of the most challenging parts of the Cyclone3 project as we try to document every function from our perl libraries and addons. Libraries are documented using the POD documentation style, other documentation is stored in DocBook documents. Everything is directly stored and served from in our subversion repository.
XULadmin Usability Help
Cyclone3 XULadmin is the most frequently used part of the Cyclone3 project as end users use it to write and organize their content everyday. It is the first XUL frontend for a open source CMS system so we are very interested in making it pleasant and comfortable to work with. We are looking for contributors which have experience with designing user interfaces and workflow. No programming skills are required as anyone with a vision of the future GUI for XULadmin is welcome to share it with us.
What is Cyclone3 XULadmin? You can also read GUI design guidelines.
Translations
We are currently supporting two languages: English and Slovak (native to former developers). To help Cyclone3 to spread out to different countries and potential contributors we are interested in translators to languages such as Hungarian, Polish, China, German or any other language. You can support Cyclone3 by lending us you mother tongue and translate our DocBook documents.
Feedback and Testing
If you do not have time to directly contribute to any parts of the Cyclone3 project we would like you share you experiences with Cyclone3 and provide us with feedback so we can make future versions of Cyclone3 better.
Sponsoring and Feature Requests
If you are a company or individual willing to support Cyclone3 development by the means of sponsored feature development please contact any Cyclone3 developer or contact Cyclone3.org directly.
User Comments