Re: Offer to help with documentation and testing
Dean Edwards
> I can spend one day a week on this, only because I would really like to
> see this project flourish.
That's about all I can manage at the moment too. I'm currently
travelling two hours per day for work and it's leaving me pretty tired. :(
> I went over the tests that I could find at Google already. So if you
> want to send the tests you've created for JSSpec, we can start there on
> base2 v1.0. There will be plenty of work to do in getting all of this up
> and running, AND it will probably take months to build completed
> documentation. I hope you are ready for that?!
The tests I am writing are for version 2.0 of base2 (the next release).
This bug:
http://code.google.com/p/base2/issues/detail?id=126
means that I have to change the version number. Because of this I have
made a few other small changes to the API. I've attached a change log to
clarify.
I've attached all of the tests that I have as well as a cut of the new
base2 library. I will check this code in soon as I have pretty much
finished development.
> There will be a lot of communication between You and I and who ever else
> you recommend on code functionality.
That's great. I've cc'ed the base2 google group. Maybe we can get some
more volunteers?
> Unit testing with JSSpec will probably work out just fine for You and
> any other developers.
It's not too late to change the testing software. I'm not tied to
JSSpec, if you prefer to use something else then I am fine with that.
> There also has to be a site somewhere for Beta testing. This will allow
> people to bang on the code in order to find bugs. We will want to
> encourage people to try anything they can think of to break the code. We
> _want_ people to bash the hell out of it. However, the Beta site is the
> controlled environment where we decide the proper way to wire the code
> to the interface.
> The Beta site is where the first rendering of documentation goes and
> examples of how to use the code. The Beta site is what I will build for
> the project. The pages are simple HTML with JavaScript, that's it. The
> Beta site must not be editable by the developer(s), this is required to
> keep testing separate from development.
I prefer static HTML too.
> If it's okay with you, I will host the Beta site and reference back to
> dean.edwards.name, code.google.com and groups.google.com.
I have base2.appspot.com and www.base2js.com if you want to use them.
But I'm happy for you set something up if you prefer.
> Regarding the logos I saw: not so good. Keep trying. I agree.
I have a friend who is an artist I might go back to him for a better logo.
> Regarding JSB: it looks good. I saw JSB before I started asking about
> base2 Beta 3.
JSB is great. I really like using it. I built this with it:
http://code.google.com/p/html5-now/
> Don't let what I'm doing with test slow you down in development, okay? I
> will catch up, but it will take time. You just plow ahead and answer my
> emails as I ask very detailed questions. Eventually though, base2 will
> need to go through testing before going live (or Gold).
Well, I'm pretty much done on this round of development. I will probably
start building a release over the weekend so the timing of this
collaboration is perfect.
> What did you think about the disclaimer for Betas I discussed in my last
> email?
>
Probably a good idea. It will avoid any confusion. I've included a
header in the release I'm sending you. Is it sufficient?
-dean
Dean Edwards
> Regarding JSSpec: You should take a look at JsTestDriver
> <http://code.google.com/p/js-test-driver/>. I just about fell out of my
> chair when I finally found a real unit testing platform for JavaScript
> that is open source. If you learn JsTestDriver and use it for Test
> Driven Development (TDD) it will help me out in a big way. After you
> finish your development, run one final full test of all the code and
> send me the results. Then I can take the results and modify the public
> facing Beta environment on the web.
I'm slightly uncomfortable with using a java based test engine. What's
so good about JsTestDriver? And what's wrong with the JavaScript based ones?
> Secrets: The fact that we are using JsTestDriver, needs to be kept a
> secret from the Public. Why? This will eventually give base2 the
> advantage in building smaller and faster solutions to compete with other
> JS frameworks. When the time is right, we can reveal our secret and
> surprise the other guys.
I'm not sure that there is any need for secrets but whatever. :)
> Alpha, Beta, Gold: Just so we are on the same page, Alpha is internal
> testing by the developers and the test team and is not available to the
> public. Beta is public testing or testing by a select group of people
> that understand the product or software. Beta testing can take much
> longer to complete than Alpha testing because there are a lot more
> people involved, often with divergent opinions. Finally, Gold is when
> Beta evolves in to the final gold master that will be reproduced to the
> public. Any issues that come up after gold need to be logged in the bug
> reporting system. Only the test team can decide when a product can be
> released from Beta to Gold. Only development can decide when a product
> can be released from Alpha to Beta.
"Gold" sounds a bit contrived. Just alpha, beta and live is fine. The
way it works now.
> Regarding static HTML: I have to change my mind on static HTML. I forgot
> that each test that is run, must be logged into a database. I prefer to
> use .NET for the back-end so the pages will be ASPX. I hope you don't
> mind my change. Using .NET also allows me to control access, where
> static HTML is very difficult to control without code behind. Adding
> code to the presentation layer is a no no, so I will do my best to keep
> the separation of code and presentation clean.
Is this a requirement of jsTestDriver? I don't want this project to get
too complicated. I may have to support it on my own one day and I don't
want to learn lots of new things to do so.
> I've started working on the web site for beta testing. When it's ready
> for viewing, I'll give you the URL. Right now, it's a mess.
Ha ha. Ok.
> Also, I'm still looking over the contents of the ZIP file you sent. It
> will take me some time to soak everything in. I will give you more
> thoughts as I have something to contribute.
>
Cool. I look forward to your opinions.
BTW, can you cc the google group from now on?
-dean