Re: [zeta-dev] Documenting our coding style
Hi Jerome,
On 11/17/2010 03:28 PM, Jerome Renard wrote:
> On Tue, Nov 16, 2010 at 1:06 PM, Tobias Schlitt wrote:
>> for another project I needed to give advice on the coding standard used
>> by Apache Zeta Components. There is some very old version of the eZ
>> Publish coding style in [1] (from 2001) but no reliable, recent source.
>> So I think we should document our coding style on the website.
>>
>> Please complete / correct my following brainstorming:
>>
>> - Indentation with 4 spaces
>> - After a "{"
>> - On breakup of long lines (> 78 chars) after a "("
>> - "{" and "}" on a new line
>> - 1 space after "(" and before ")"
>> - No space after "[" and before "]"
>> - 1 space after ","
>> - 1 space before and after "."
>> - Almost always camelCase
>> - classes always start with ezc followed by an upper case char
>> - constants all in upper case with "_"
> Looks good.
> A precision might be needed though about the 78 chars limit :
> As far as I remember (correct me if I am wrong) the limit it 80 chars
> but since there is one space after the "(" and before ")" that
> makes the string longer or equal than 80 chars hence the line breakup.
>
> (Not sure I am completel clear here :/)
yeah, in fact there is a limit of 80 chars per line. I think I had 78 in
mind from text stuff.
Regards,
Toby
--
Tobias Schlitthttp://schlitt.infoGPG Key: 0xC462BC14
Want to hire me? Need quality assurance?http://qafoo.com
eZ Components are Zeta Components now! http://bit.ly/9S7zbn
[zeta-dev] Final: "Status update" [Was: Re: [zeta-dev] Draft: "Status update" blog entry]
Hi, I incorporated all feedback into the status update blog entry and would ask you to review it once more. I also added the links and meta information to it. Please find the final version attached and in SVN under website/content/news/002_status_update.txt My plan is to publish it on Monday morning. Regards, Toby -- Tobias Schlitthttp://schlitt.infoGPG Key: 0xC462BC14 Want to hire me? Need quality assurance?http://qafoo.com eZ Components are Zeta Components now! http://bit.ly/9S7zbn = Status update = :Keywords: Apache Zeta Components, eZ Components, update, contributions, Apache Foundation, processes, ASF, PHP 5, high quality :Description: There has been a lot of work on migrating eZ Components to the Apache Incubator and therefore in direction of Apache Zeta Components. This post gives a status update in direction of infrastructure, processes and plans for the near future. :Abstract: It's been a while since Apache Zeta Components was `officially accepted for incubation`__ in the Apache Software Foundation in May 2010. Since then, a lot of progress has been made, especially in the area of technical infrastructure and code drop. So, it's time to present the current status of the project and ask you to actively take part in the community! __ http://mail-archives.apache.org/mod_mbox/incubator-general/201005.mbox/%3c4bf68e50.1060...@schlitt.info%3e It's been a while since Apache Zeta Components was `officially accepted for incubation`__ in the Apache Software Foundation in May 2010. Since then, a lot of progress has been made, especially in the area of technical infrastructure and code drop. So, it's time to present the current status of the project and ask you to actively take part in the community! __ http://mail-archives.apache.org/mod_mbox/incubator-general/201005.mbox/%3c4bf68e50.1060...@schlitt.info%3e -- Infrastructure -- There's been a lot of work on the technical infrastructure for Zeta. First off, we have a `new SVN`__, which you should use from now on to obtain the Zeta code. We did not roll an official release yet, mostly due to the fact that the release process is right now in discussion, to be adjusted to ASF needs. __ https://svn.apache.org/repos/asf/incubator/zetacomponents The project mandatory mailing lists have been set up. So, if you want to contribute and take part in the community, please register for `zeta-...@incubator.apache.org`__. If you are only using Zeta Components, please use the `user mailinglist at zeta-u...@incubator.apache.org`__ to discuss issues with other users. However, the developer mailinglist is also open for questions and problems. If you want to be up to date on commits to the SVN repository, you should subscribe to `zeta-comm...@incubator.apache.org`__ and if you want to help fixing bugs, please subscribe to `zeta-iss...@incubator.apache.org`__. __ mailto:zeta-dev@incubator.apache.org __ mailto:zeta-us...@incubator.apache.org __ mailto:zeta-comm...@incubator.apache.org __ mailto:zeta-iss...@incubator.apache.org Subscribing to any of the Zeta mailing lists is easy. Just send an empty email to :: zeta-*-subscr...@incubator.apache.org so, for example for the dev list, email `zeta-dev-subscr...@incubator.apache.org`__. __ mailto:zeta-dev-subscr...@incubator.apache.org We also have a new `issue tracker`__, which you can use to file bugs. Furthermore, there is a `code browser`__ which you can use to inspect our source code without downloading it or checking it out from SVN. __ https://issues.apache.org/jira/browse/ZETACOMP __ https://fisheye6.atlassian.com/browse/zetacomponents/ - Code drop - `eZ Systems AS`__ has performed the so-called *code drop*, which essentially means that the complete eZ Components SVN history was sent to the ASF and a contract was signed which completes the donation. Furthermore, Ole Marius Smestad from eZ Systems has performed license and copyright changes after the code was imported to `our new SVN`__. So, the (now) Zeta Components code is from now on licensed under the `Apache License 2.0`__. For you as a user, this does not change much, since the Apache License is basically as permissive as the former New BSD license was. __ http://ez.no __ https://svn.apache.org/repos/asf/incubator/zetacomponents __ http://apache.org/licenses/ At this place, we want to take the opportunity to thank eZ Systems a lot for donating the eZ Components source code base to the ASF and therefore making Apache Zeta Components possible. - Contributions - Quite some contributions to Apache Zeta Components are in discussion on the developer mailinglist: Jerome Renard and James Pic joined forces for providing an `overrider mechanism`__ for the Configuration component. This technique should allow you to specify multiple directories for configuration files (INIs
Re: [zeta-dev] Proposal: Release process
Hi guys, On 11/17/2010 03:58 PM, Jerome Renard wrote: > On Tue, Nov 16, 2010 at 5:43 PM, Gaetano Giunta > wrote: > [...] >> But think about this: why is eZ Publish bundling the whole of the ZetaC when >> it only uses a couple of components? > Simply because that was the easiest (and quickest) solution when I > wrote the build system ;) > I agree with you only required components should be included though > but this discussion must > go to another list ;) without talking too much of eZ Publish here, I think it makes sense in that case. eZ Publish is a framework for which people want to write extensions easily. So delivering the whole Zeta stack provides them with more comfort actually. However, for a custom app, it does not make sense to bundle all Zeta Components if you only want to use e.g. Graph or Mail (which are 2 of the most used components). Regards, Toby -- Tobias Schlitthttp://schlitt.infoGPG Key: 0xC462BC14 Want to hire me? Need quality assurance?http://qafoo.com eZ Components are Zeta Components now! http://bit.ly/9S7zbn
Re: [zeta-dev] Draft: "Status update" blog entry
Hi Jerome, On 11/17/2010 04:09 PM, Jerome Renard wrote: > On Tue, Nov 16, 2010 at 10:58 PM, Tobias Schlitt wrote: >> I've made up a draft for a "status update" blog entry on our website. >> Please find this post attached and in SVN for review (links are still >> missing), so I can publish it in a near future. >> >> I would be happy if we could provide such status updates somewhat >> regularly (maybe once a month?), in order to keep people informed and to >> attract more contributors. What do you think? > Minor fixes in the patch attached. Thanks, applied. :) > PS : > I really have to work on that override mechanism for > Configuration That'd be great. I'll try to get the wiki up for such stuff soonish, as discussed here. Did you already send an iCLA? Regards, Toby -- Tobias Schlitthttp://schlitt.infoGPG Key: 0xC462BC14 Want to hire me? Need quality assurance?http://qafoo.com eZ Components are Zeta Components now! http://bit.ly/9S7zbn
Re: [zeta-dev] Draft: "Status update" blog entry
Hi Nicolas, On 11/17/2010 02:33 PM, Nicolas Pastorino wrote: > On Wed, Nov 17, 2010 at 1:49 PM, Tobias Schlitt wrote: >> On 11/17/2010 11:27 AM, Nicolas Pastorino wrote: >>> From a community management perspective, i think this is a mandatory >>> process : let information flow, regularly. I can also propose, if you >>> guys judge this helps, to push these posts on a dedicated Apache Zeta >>> Components blog on share.ez.no (it is now possible to create >>> "personal" blogs on share.ez.no). >> I'd love if our blog posts could be aggregates somehow on share.ez.no. >> Moving the blog there is not a good idea and would conflict with ASF >> rules AFAIK. I would also not like to duplicate content. > I was of course not suggesting moving the Zeta blog there :) I understand > that duplicating content is tedious SEO-wise. >> Is an automatic aggregation to share.ez.no possible? > Yes. Until now, http://planetezpublish.org/ is the feed aggregator. We are > planning on surfacing this aggregator's feed on share.ez.no, under the blogs > section. We can safely imagine subscribing the Zeta blog to this aggregator, > in turn soon displayed on share.ez.no. What would you think ? Sounds great, you can just go ahead and start aggregating http://incubator.apache.org/zetacomponents/news.rss for now. Thanks, Toby -- Tobias Schlitthttp://schlitt.infoGPG Key: 0xC462BC14 Want to hire me? Need quality assurance?http://qafoo.com eZ Components are Zeta Components now! http://bit.ly/9S7zbn
Re: [zeta-dev] Draft: "Status update" blog entry
Hi all, On 11/17/2010 01:54 PM, Tobias Schlitt wrote: > On 11/17/2010 12:22 PM, Maxime Thomas wrote: >> Excellent ! >> A blog is effectively the best way to inform people with some modern way to >> inform (RSS). > actually, the current news section on the website is already a blog > (WCV) but with the commenting and trackback functionality stripped, > since we can only use static content. > > I agree that a full-featured blog would be nice. after discussing this roughly with Kore and Derick, I came to a different conclusion. By now we have a "blog" in our website integrated which works well for publishing news and status updates. I don't think we will have enough content to be published on a dedicated blog yet. And opening one on blogs.a.o now would bring "just another system to take care of". So, I think we should stick with the current solution. Regards, Toby -- Tobias Schlitthttp://schlitt.infoGPG Key: 0xC462BC14 Want to hire me? Need quality assurance?http://qafoo.com eZ Components are Zeta Components now! http://bit.ly/9S7zbn
Re: [zeta-dev] Draft: "Status update" blog entry
Hi Tobias, On Tue, Nov 16, 2010 at 10:58 PM, Tobias Schlitt wrote: > Hi, > > I've made up a draft for a "status update" blog entry on our website. > Please find this post attached and in SVN for review (links are still > missing), so I can publish it in a near future. > > I would be happy if we could provide such status updates somewhat > regularly (maybe once a month?), in order to keep people informed and to > attract more contributors. What do you think? > Minor fixes in the patch attached. Cheers :) PS : I really have to work on that override mechanism for Configuration -- Jérôme Renard http://39web.fr | http://jrenard.info | http://twitter.com/jeromerenard 002_status_update.diff.gz Description: GNU Zip compressed data
Re: [zeta-dev] Proposal: Release process
Hi Maxime, On Tue, Nov 16, 2010 at 5:47 PM, Maxime Thomas wrote: [...] > And honestly, I cannot see the problem of downloading all even if you don't > use some parts. Who can do the more can do the less. Yes, but "less is more" :D Ok ---> [] -- Jérôme Renard http://39web.fr | http://jrenard.info | http://twitter.com/jeromerenard
Re: [zeta-dev] Proposal: Release process
Hi Gaetano, On Tue, Nov 16, 2010 at 5:43 PM, Gaetano Giunta wrote: [...] > But think about this: why is eZ Publish bundling the whole of the ZetaC when > it only uses a couple of components? Simply because that was the easiest (and quickest) solution when I wrote the build system ;) I agree with you only required components should be included though but this discussion must go to another list ;) -- Jérôme Renard http://39web.fr | http://jrenard.info | http://twitter.com/jeromerenard
Re: [zeta-dev] Proposal: Release process
Hi Tobias; On Thu, Nov 4, 2010 at 5:28 PM, Tobias Schlitt wrote: > Hi, > > I have studied the guidelines for releases in the ASF and tried to make > up a release process document for us. Please find it attached for > discussion. You can also find it in our SVN under > > docs/release_process.txt > > The document summarizes the requirements for releases roughly and then > tries to relealize these in a release process specific to Zeta. > > There are some open issues marked with notes in this document, which > need to be decided on. > I just read the document and I have a few (nitpicking) questions. " In ASF, an **RC is any kind of package that is meant to be published later**, but is at first only provided to developers for testing." How will version numbers will be managed ? I have the feeling the version numbering system will become completely different from the previous versions (eZ Components days). Am I correct ? "The first type refers to a release of a single component, independently from any other." Since (almost) all ZC have a dependecy with the Base component, what will be the process in case of (major) update of ezcBase ? Will all the other components released once again ? "This choice can happen informally among the maintainers of a component." What does informally means here ? If that means deciding to release over jabber or IRC while chatting with a maintainer after lunch I do not agree. It is not really a of matter of trust but more a matter of transparency. If a (group of) maintainer(s) decide to release a new version of a specific component, fair enough but I think this decision must be sent to the dev-(users ?) mailing list to at least inform that an update will happen. "A full package release does not occur as needed, but fixed dates twice a year." I believe you meant every 6 months. Just to avoid any miscomprehension ".. note:: Determine release times." How about March and September ? I do not know what you guys think but release in January and June (or July) does not sound that good to me. I also fixed a few minor issues (spelling, typos etc) in the document, patch attached. :) -- Jérôme Renard http://39web.fr | http://jrenard.info | http://twitter.com/jeromerenard release_process.diff.gz Description: GNU Zip compressed data
Re: [zeta-dev] Documenting our coding style
Hi Tobias,
On Tue, Nov 16, 2010 at 1:06 PM, Tobias Schlitt wrote:
> Hi,
>
> for another project I needed to give advice on the coding standard used
> by Apache Zeta Components. There is some very old version of the eZ
> Publish coding style in [1] (from 2001) but no reliable, recent source.
> So I think we should document our coding style on the website.
>
> Please complete / correct my following brainstorming:
>
> - Indentation with 4 spaces
> - After a "{"
> - On breakup of long lines (> 78 chars) after a "("
> - "{" and "}" on a new line
> - 1 space after "(" and before ")"
> - No space after "[" and before "]"
> - 1 space after ","
> - 1 space before and after "."
> - Almost always camelCase
> - classes always start with ezc followed by an upper case char
> - constants all in upper case with "_"
>
Looks good.
A precision might be needed though about the 78 chars limit :
As far as I remember (correct me if I am wrong) the limit it 80 chars
but since there is one space after the "(" and before ")" that
makes the string longer or equal than 80 chars hence the line breakup.
(Not sure I am completel clear here :/)
Cheers :)
--
Jérôme Renard
http://39web.fr | http://jrenard.info | http://twitter.com/jeromerenard
Re: [zeta-dev] Draft: "Status update" blog entry
Hi Toby, On Wed, Nov 17, 2010 at 1:49 PM, Tobias Schlitt wrote: > Hi Nicolas, > > On 11/17/2010 11:27 AM, Nicolas Pastorino wrote: > > > From a community management perspective, i think this is a mandatory > > process : let information flow, regularly. I can also propose, if you > > guys judge this helps, to push these posts on a dedicated Apache Zeta > > Components blog on share.ez.no (it is now possible to create > > "personal" blogs on share.ez.no). > > I'd love if our blog posts could be aggregates somehow on share.ez.no. > Moving the blog there is not a good idea and would conflict with ASF > rules AFAIK. I would also not like to duplicate content. > I was of course not suggesting moving the Zeta blog there :) I understand that duplicating content is tedious SEO-wise. > > Is an automatic aggregation to share.ez.no possible? > Yes. Until now, http://planetezpublish.org/ is the feed aggregator. We are planning on surfacing this aggregator's feed on share.ez.no, under the blogs section. We can safely imagine subscribing the Zeta blog to this aggregator, in turn soon displayed on share.ez.no. What would you think ? Cheers, -- Nicolas > > Cheers, > Toby > > -- > Tobias Schlitthttp://schlitt.infoGPG Key: 0xC462BC14 > Want to hire me? Need quality assurance?http://qafoo.com > eZ Components are Zeta Components now! http://bit.ly/9S7zbn >
Re: [zeta-dev] Draft: "Status update" blog entry
Hi Thomas, On 11/17/2010 12:22 PM, Maxime Thomas wrote: > Excellent ! > A blog is effectively the best way to inform people with some modern way to > inform (RSS). actually, the current news section on the website is already a blog (WCV) but with the commenting and trackback functionality stripped, since we can only use static content. I agree that a full-featured blog would be nice. Regards, Toby -- Tobias Schlitthttp://schlitt.infoGPG Key: 0xC462BC14 Want to hire me? Need quality assurance?http://qafoo.com eZ Components are Zeta Components now! http://bit.ly/9S7zbn
Re: [zeta-dev] Draft: "Status update" blog entry
Hi Christian, On 11/17/2010 11:58 AM, Christian Grobmeier wrote: >> I would be happy if we could provide such status updates somewhat >> regularly (maybe once a month?), in order to keep people informed and to >> attract more contributors. What do you think? > Great idea! > Btw, you can have an apache blog by requesting it from jira > http://blogs.apache.org/ > In this blog you have the chance for a preview and send the preview to > the dev list were people can make suggestions or vote about. Sounds neat. We can then incorporate the blog into the website by aggregating it on the front page. What do the others think? Regards, Toby -- Tobias Schlitthttp://schlitt.infoGPG Key: 0xC462BC14 Want to hire me? Need quality assurance?http://qafoo.com eZ Components are Zeta Components now! http://bit.ly/9S7zbn
Re: [zeta-dev] Draft: "Status update" blog entry
Hi Gaetano, On 11/17/2010 11:41 AM, Gaetano Giunta wrote: > Tobias Schlitt wrote: >> I've made up a draft for a "status update" blog entry on our website. >> Please find this post attached and in SVN for review (links are still >> missing), so I can publish it in a near future. > We did not role an official release, yet, => We did not roll an official > release yet, > At this place, we want to seize the chance to => We want to take the > opportunity to thanks for the corrections. They're incorporated in SVN. Regards, Toby -- Tobias Schlitthttp://schlitt.infoGPG Key: 0xC462BC14 Want to hire me? Need quality assurance?http://qafoo.com eZ Components are Zeta Components now! http://bit.ly/9S7zbn
Re: [zeta-dev] Draft: "Status update" blog entry
Hi Nicolas, On 11/17/2010 11:27 AM, Nicolas Pastorino wrote: > From a community management perspective, i think this is a mandatory > process : let information flow, regularly. I can also propose, if you > guys judge this helps, to push these posts on a dedicated Apache Zeta > Components blog on share.ez.no (it is now possible to create > "personal" blogs on share.ez.no). I'd love if our blog posts could be aggregates somehow on share.ez.no. Moving the blog there is not a good idea and would conflict with ASF rules AFAIK. I would also not like to duplicate content. Is an automatic aggregation to share.ez.no possible? Cheers, Toby -- Tobias Schlitthttp://schlitt.infoGPG Key: 0xC462BC14 Want to hire me? Need quality assurance?http://qafoo.com eZ Components are Zeta Components now! http://bit.ly/9S7zbn
Re: [zeta-dev] Draft: "Status update" blog entry
Excellent ! A blog is effectively the best way to inform people with some modern way to inform (RSS). 2010/11/17 Christian Grobmeier > > I would be happy if we could provide such status updates somewhat > > regularly (maybe once a month?), in order to keep people informed and to > > attract more contributors. What do you think? > > Great idea! > Btw, you can have an apache blog by requesting it from jira > http://blogs.apache.org/ > > In this blog you have the chance for a preview and send the preview to > the dev list were people can make suggestions or vote about. > Best regards, > Christian >
Re: [zeta-dev] Draft: "Status update" blog entry
> I would be happy if we could provide such status updates somewhat > regularly (maybe once a month?), in order to keep people informed and to > attract more contributors. What do you think? Great idea! Btw, you can have an apache blog by requesting it from jira http://blogs.apache.org/ In this blog you have the chance for a preview and send the preview to the dev list were people can make suggestions or vote about. Best regards, Christian
Re: [zeta-dev] Draft: "Status update" blog entry
Tobias Schlitt wrote: Hi, I've made up a draft for a "status update" blog entry on our website. Please find this post attached and in SVN for review (links are still missing), so I can publish it in a near future. I would be happy if we could provide such status updates somewhat regularly (maybe once a month?), in order to keep people informed and to attract more contributors. What do you think? Cheers, Toby We did not role an official release, yet, => We did not roll an official release yet, At this place, we want to seize the chance to => We want to take the opportunity to ciao Gaetano
Re: [zeta-dev] Draft: "Status update" blog entry
Hi Toby, From a community management perspective, i think this is a mandatory process : let information flow, regularly. I can also propose, if you guys judge this helps, to push these posts on a dedicated Apache Zeta Components blog on share.ez.no (it is now possible to create "personal" blogs on share.ez.no). Cheers, -- Nicolas On Nov 16, 2010, at 22:58 , Tobias Schlitt wrote: > Hi, > > I've made up a draft for a "status update" blog entry on our website. > Please find this post attached and in SVN for review (links are still > missing), so I can publish it in a near future. > > I would be happy if we could provide such status updates somewhat > regularly (maybe once a month?), in order to keep people informed and to > attract more contributors. What do you think? > > Cheers, > Toby > > -- > Tobias Schlitthttp://schlitt.infoGPG Key: 0xC462BC14 > Want to hire me? Need quality assurance?http://qafoo.com > eZ Components are Zeta Components now! http://bit.ly/9S7zbn > <002_status_update.txt> -- Nicolas Pastorino eZ Community Manager Community portal : http://share.ez.no Twitter : @ezcommunity / @jeanvoye Skype : bimbamboombimbla Phone : +33 (0)671791318 eZ Systems | http://ez.no
