Shash, Good suggestions. I agree with the proposals too. Having good tests and documentation will improve Keel quality and stability. Although it requires more initial effort and some discipline, having good tests should be beneficial for contributions since we can verify that our changes work and don't break anything else.
Documentation: +1 JUnit tests before checkin: +1 Functional tests before addition of new UI modules: +1 Minimal Javadoc requirements: +1 Doug -----Original Message----- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] Behalf Of Shash Chatterjee Sent: Tuesday, December 16, 2003 12:33 PM To: [EMAIL PROTECTED] Subject: [Keelgroup] [PROPOSAL] Feedback on testing All, There are two things that lack in Keel: documentation and tests. The first one is a moving target and we are getting better at it. It is also something that I expect will improve over time. The test piece, is essential. Mike has gone through and put in an impressive set of framework for unit as well as functional testing, and I believe he has plans for expanding the functional tests even more. But none of that is any good if we lack tests to begin with. I personally haven't supplied tests to speak of, so my New Year's resolution for Keel is going to be to remedy that. I was thinking that we should make it a *requirement* to have included unit tests for every new module that is checked into CVS. I realize that it will be a barrier for new and exciting things to be contributed into Keel, but I think it will be worth it. For UI front-ends, we should also require minimal functional tests. I know everybody generally supports the idea of unit-tests, but I am asking specifically the community about making unit-tests a pre-condition for checkins. An alternative might be to allow checkins, but not including a module in a release/download unless there are a significant number of tests. In the same vein, what about minimal javadoc requirements? Shash http://keelframework.org/documentation Keelgroup mailing list [EMAIL PROTECTED] http://lists.keelframework.com/listinfo.cgi/keelgroup-keelframework.com http://keelframework.org/documentation Keelgroup mailing list [EMAIL PROTECTED] http://lists.keelframework.com/listinfo.cgi/keelgroup-keelframework.com
