|Version 2 (modified by warren.weckesser, 2 years ago)|
Before considering a change complete, be sure you can answer all the following with "Yes".
- 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, including example(s) if the object is a function?
- Have you updated the module-level documentation?
There are (usually) two relevant files:
- Have you updated the release notes? (doc/release/#.#.#-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.
Finally, when you make a commit, give a useful commit message. The following provides a good discusson of commit messages: http://who-t.blogspot.com/2009/12/on-commit-messages.html