Developer Guidelines

Here are some guidelines for Webware Developers:

Design

If your change is non-backward-compatible or involves design considerations, please discuss it on the webware-devel list before checking it in (and preferably before implementing it!). Your ideas are probably good, but someone else on the list may come up with better ones!

Following Python's development model, Webware also has a BDFL. Chuck Esterbrook is Webware's BDFL. As such, he has final say over Webware design issues and if he makes a pronouncement, please obey it.

Jay and Geoff can also make pronouncements if Chuck isn't available or if they are better qualified to decide on whatever issue is at hand. But pronouncements from Jay or Geoff are overruled by a pronouncement from the BDFL.

Coding

Follow the Webware Style Guidelines. http://www.webwareforpython.org/Docs/StyleGuidelines.html

Testing

Please test before checking in changes. If the component you are modifying has a test suite, please add a test case to the test suite if appropriate.

Documentation

Please update the Release Notes. If a new feature has been added, please update the User's Guide. If a new setting has been added, please update the Configuration Guide.

Becoming a Webware Developer

If you agree to abide by the rules listed above and you want SVN write access, send an email to Chuck Esterbrook and Geoff Talvola. You should let them know what it is you plan to do with SVN -- fix bugs, improve the docs, add new features, write a regression test suite, or whatever. Also, if you can show evidence of one or more of these:

Then Chuck or Geoff will probably give you write access.

-- GeoffTalvola - 06 Jun 2002