My favorites | Sign in
Project Home
READ-ONLY: This project has been archived. For more information see this post.
Search
for
QualityAssurance  
The Quality Assurance for eggdrop tcl scripts
Phase-QA, Featured
Updated Jul 12, 2011 by rutg...@gmail.com

Introduction

The eggtcl project team will use this to ensure Quality Assurance is kept for all of the scripts added to the project. In order for a script to become accepted, it has to pass all of these points.

This list is by no means the be-all and end-all checklist of getting scripts accepted. The ultimate goal of this project is to list quality scripts that are useful, clean and maintainable. If a member feels like a script doesn't live up to those goals, it won't be accepted, even if it passes all of these checks.

Although not required for acceptance, it is suggested that script authors read the Tcl Style Guide and use it as a guiding light for what good code should look like. The guide has a lot of good points regarding style, and while all of it isn't commonly followed, a lot of it is. If your code follows it and passes the checklist below, it stands a very high chance of being accepted.

Check list

Is it fit for purpose?

  • Does it run on an eggdrop?
  • Does it function as described?
  • Does it require Tcl and eggdrop packages?

Is it distributable?

  • Does it include a valid GPLv2 compatible license?
  • Does it conform to our header standard?

Is the code maintainable?

  • Does it pass a TCL SyntaxCheck?
  • Does it include comments?

Is the code clean?

  • Does it use correct output queues?
  • Does it use namespaces?
  • Does it return correct codes from procs called by binds?
  • Does it brace expr's and if statements?
  • Does it properly separate lists and strings?

Something missing?

Have we missed something here? Let us know what you look for in a quality script and we'll update this.

Powered by Google Project Hosting