Developer comments in .php/.tpl/.css files?

[falk.koziol]

Hi,

I d/l'ed the current nightly build (s9y_200603101438) and the 1.0 beta in search of more comments inside the above mentioned files.

Are the CVS snapshots better commented or does anyone of the developers think that it might be a reasonable task to add more comments to the sourcecode?

One of the first things I started with when hacking away on the s9y sourcecode and stylesheets was making papernotes of the nesting of styles and smarty calls,commenting PHP code and - for the styles - reorganizing them.

Is there any kind of developer documentation, will or should or need it be? If yes, I'd like to contribute my 'findings' helping other developers to better find their way around in the code.
It will become more in the future, since I'm quite addicted to s9y since I installed it...not for blogging yet, but for diving around in the code to accomodate my wishes...I'm a DIY type

Cheers,

Falk

[garvinhicking]

Hi!

It's great that you get involved with Serendipity!

In fact, our 1.0 versions contain PHPdoc documentation for all PHP code function descriptions.Plus, additoinal information can be found on our Wiki at http://www.s9y.org/ in the "Technical documentation" section.

Then in our additional_themes CVS repository, we have a commented CSSstylesheet forthe default styles, which might help you. I think that one is also in our technical documentation, though.

If you would like to add your findings there,please have a go at it! Send me a PM and I can create you a Wiki account -but many areas in our wiki are already publically writable.

Adding useful comments to the sourcecode is also a very useful thing. If you like, you could create some patches against our latest SVN trunk and I could commit them? If that works out well, I could also give you SVN access, if you like.

It's great to hear you like to stuck your hands deep into code - that's something we need! We are always looking for new developers, so any help you cangive us is highly appreciated. I also hope you like what you see in the Serendipity code. We did try keep everything as nice as possible. We also adhere to the PEAR coding guidelines in most of our cases.

Have fun & Regards,
Garvin