Here is the general protocol to follow for any new components/modifications to existing components(ie list applies to public facing changes that people will notice to existing comps or brand new components equally):
-) If it's possible try to unit test any functionality you can using testng. We haven't been doing a lot of direct component tests (I hadn't discovered/understood all of the component unit tests tapestry has until a little while ago), but if you want to be the first to blaze a path for this by all means :) . A note on unit tests - though tacos needs to support jre 1.4 , there's nothing stopping us from using all the 1.5 > features we want in unit tests...So feel free to upgrade the 1.4 based testng to one that supports annotations, upgrade easymock to use the new 2.0 API if you like, etc.. (Easymock is the easiest way to test them currently)
-) Checkstyle is checked into the project as a shared resource as well as code formatter files (for eclipse). Definitely do use the shared checkstyle file, and if possible try using the formatter. (You don't have to use eclipse so this is of course optional ;) )
-) All features / components should have a corresponding demo page that tries to show a fairly thorough example (or two when needed ) of the component.
-) Documentation! The xdocs doc files are also checked in. They are built using forrest (one of the latest nightly tars should do it, forrest.apache.org ). To run the docs just install forrest and invoke "forrest" from the tacos main directory.
-) Hasn't been done in the past (lots of js code I wrote is definitely pretty ugly looking ), but feel free to take a peak at http://dojotoolkit.org/docs/js_style_guide.html for a general guide on what conventions we'd like to follow in the js code.
I don't think that's too stringent, they've never been made into official rules but everyone seems to be following them (mostly) so far.
Finally....Two last points. Feel free to code and play with things, but also keep in mind that a lot of people/companies are using tacos builds directly from subversion trunk (since so much changes from release to release)..
I'm sure it goes without saying, but when I originally found tacos I was very impressed with the features/components demo'd, but even more impressed with the quality and thoroughness of code Viktor had maintained. I'd much much rather see components come in slowly and perfected rather than a blitzkrieg of everything we can possibly add.
I'm very excited about all of the good work everyone is adding in, but also ~very~ anxious about seeing the codebase grow too fast when there is still a lot of cleanup left to be done. (most of it my old/bad code I'm sure, though Andy/Leonardo/Felix have been doing a ton of cleanup lately) So...Just keep an eye out for quality over quantity if at all possible. (this isn't directed at anyone in particular, I haven't updated my local tacos copy in a few days - or weeks? - so don't know what is going on completely :) )
There...Long winded but I just ate dinner so it made it easy to waste time on talking instead of coding :)
On 5/11/06, Sam Gendler <
[EMAIL PROTECTED]> wrote:
I have sent my sourceforge info to Viktor, but I should probably ask
about commit protocol before attempting anything drastic. I am
heading to Moscow for next week, so I'll probably have a fair amount
to check in when I get back. I've got guys working on making Tacos
widgets for dojo ComboBox, Button, Menu, and various others. I know
there is some kind of _javascript_ unit test framework. Is there
documentation somewhere about how it works so that we can add tests
for new components to it? What is the protocol for making sure it is
ok to commit something to the trunk before doing so? I'm not seeing
anything in the wiki or at sourceforge.
-------------------------------------------------------
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmdlnk&kid0709&bid&3057&dat1642
_______________________________________________
Tacos-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/tacos-devel
--
Jesse Kuhnert
Tacos/Tapestry, team member/developer
Open source based consulting work centered around dojo/tapestry/tacos/hivemind.
