|
Size: 717
Comment: These guidelines are generic enough
|
Size: 696
Comment: Minor changes to make the page generic
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 5: | Line 5: |
| * The code from your Sage notebook should be self-sufficient. | * The code from your Sage notebook (or ipython shell) should be self-sufficient. |
| Line 11: | Line 11: |
| * Where and Why were you stuck? [Does Sage lack a function? Documentation needs improvement?] [[SageDays/SprintsHelp|How-to upload code?]] |
* Where and Why were you stuck? [Does the software lack a function? Documentation needs improvement?] |
General Guidelines when Sprinting
Do NOT include any content from the Book. Not even the problem statement.
- The code from your Sage notebook (or ipython shell) should be self-sufficient.
- Use meaningful variable names
- Include comments where required
- Add comments explaining what your problem is solving, etc.
- If you have tried to solve a problem but were unable to do it, please write down comments.
- What did you attempt to do?
- Where and Why were you stuck? [Does the software lack a function? Documentation needs improvement?]