[SciPy-Dev] Checkin checklist

Warren Weckesser warren.weckesser at enthought.com
Sat May 29 20:58:38 EDT 2010


Here's a first shot at a checklist to use when working on scipy.  
Something like this should be in the development section of the wiki.  
What do you think?

Checkin checklist:

* Have you created tests for the new functionality, and have you run
  all the module's tests to ensure you haven't broken something else?

* Do all the affected classes, methods, and functions have accurate
  docstrings that conform to the scipy documentation standard? 

* Have you updated the module-level documentation?
  There are (usually) two relevant files:
  * scipy/some_package/info.py
  * doc/source/some_package.rst

* Have you updated the release notes? (doc/release/0.8.0-notes.rst)
  Any API changes (new stuff, changed stuff, deprecations, etc)
  should be noted in the release notes.

* If the changes affect a tutorial, have you updated the tutorial?
  The tutorials are in doc/source/tutorial.




More information about the SciPy-Dev mailing list