|
⇤ ← Revision 1 as of 2012-01-06 00:56:22
Size: 1092
Comment:
|
Size: 1183
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 7: | Line 7: |
| * The patch should be generated by Mercurial and have a sensible commit message. | * The patch should be generated by Mercurial and have a sensible commit message, including the trac ticket number. |
| Line 20: | Line 20: |
| * If the patch fixes a trac ticket, the ticket number should be mentioned in the doctest. | * If the patch fixes a defect, there should be a doctest checking that the defect is fixed, and the comment should mention the trac ticket number. |
This is a checklist that can be consulted when reviewing a patch.
General
The patch should apply cleanly on top of the latest development release.
- There should be no trailing whitespace on any line touched by the patch.
- The patch should be generated by Mercurial and have a sensible commit message, including the trac ticket number.
make ptestlong should pass with the patch applied.
- Run an interactive sage session, and manually exercise the affected code.
Documentation
Run sage -docbuild reference html to rebuild the reference docs. View any affected pages.
- View affected documentation from within a sage session.
- All variables in documentation should be enclosed in backticks.
Doctests
All new code should be doctested. Use sage --coverageall to make sure the doctest coverage has not gone down.
- If the patch fixes a defect, there should be a doctest checking that the defect is fixed, and the comment should mention the trac ticket number.
New Functions
All new functions must have INPUT, OUTPUT, EXAMPLES, and TESTS sections.