|
Size: 2220
Comment: Removed the 'general observations' section.
|
Size: 1840
Comment: Moved stuff around and changed things.
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 5: | Line 5: |
| This exercise is similar to ../PeerReview, however rather than a physical meeting we will be conducting a tele-conference on 13th June 2007. It is a ''triangular round-robin'' where each team reviews the work of another, within a triplet. We are ''reviewing'' the work of [http://www.jisc.ac.uk/whatwedo/programmes/elearning_framework/demo_designshare.html DesignShare]. In turn, we are being ''reviewed'' by [http://www.essex.ac.uk/chimera/projects/resourcebrowser/ ResourceBrowser]. | This exercise is similar to the ["../PeerReview" first] peer-review exercise. However rather than a physical meeting we will be conducting a tele-conference on 13th June 2007. It is a ''triangular round-robin'' where each team reviews the work of another, within a triplet. We are ''reviewing'' the work of [http://www.jisc.ac.uk/whatwedo/programmes/elearning_framework/demo_designshare.html DesignShare]. In turn, we are being ''reviewed'' by [http://www.essex.ac.uk/chimera/projects/resourcebrowser/ ResourceBrowser]. |
| Line 13: | Line 13: |
| * Software works "out-of-the-box"! Compiles and runs from a CVS check-out. It is true that this reviewer [AO'C] has had some familiarity with building [http://www.reload.ac.uk Reload] before (for which this project is a plug-in) and a superficial understanding of Eclipse plugins, but it goes to show that if you write against a standard framework ([http://www.reload.ac.uk/ Reload] / [http://eclipse.org/ Eclipse]) you can "get away" without having any documentation ;-) . | * Could not find a project blog - '''there is a project blog (albeit sparsely populated one)'''. * License is probably in the wrong place - should probably be placed at the top of the file ''above'' the `package` declaration. - '''this has been fixed'''. |
| Line 15: | Line 16: |
| * Could not find a project blog. * All the CVS commit messages are blank - helpful to have a bit more information, even if it's just ''"Added a bit more code ..."'' ;-) . * License is probably in the wrong place - should probably be placed at the top of the file ''above'' the `package` declaration. * A lot of object-oriented GUI programming involves subclassing and overriding of (callback) methods. Therefore, as the javadoc tool copies entries for overridden methods from the superclass, it is not necessary to document these methods (unless they deliberately deviate from the expected behaviour !). Or, put another way, document the `private` methods which these callback methods call / do the actual work. |
* All the CVS commit messages are blank - helpful to have a bit more information, even if it's just ''"Added a bit more code ..."'' ;-) - '''this was highlighted in the previous exercise'''. * Whilst I (`AO'C`) could the project to build and run from a cvs checkout as an Eclipse workbench project, I couldn't get it to run by dropping the [http://www.reload.ac.uk/beta/OpenDock_Plugin.zip plugin] into a download of [http://www.reload.ac.uk Reload] (Ubuntu Linux 7.04 ''Feisty Fawn''). `AO'C` - Alexis O'Connor. |
Frockle/PeerReview2
Introduction
This exercise is similar to the ["../PeerReview" first] peer-review exercise. However rather than a physical meeting we will be conducting a tele-conference on 13th June 2007. It is a triangular round-robin where each team reviews the work of another, within a triplet. We are reviewing the work of [http://www.jisc.ac.uk/whatwedo/programmes/elearning_framework/demo_designshare.html DesignShare]. In turn, we are being reviewed by [http://www.essex.ac.uk/chimera/projects/resourcebrowser/ ResourceBrowser].
Main Exercise: DesignShare (conducted on April 24th 2007)
Pluses
Good project [http://designshare.opendocument.net/Application/index.php?crumb=2&action=page&page=About+DesignShare web-site] which provides a nice introduction.
- Sensible code formatting and comments.
Being built as an Eclipse plugin, so effectively a standard build procedure (no scripts required) and then just Run As -> Eclipse Application to execute it.
Could not find a project blog - there is a project blog (albeit sparsely populated one).
License is probably in the wrong place - should probably be placed at the top of the file above the package declaration. - this has been fixed.
Minuses
All the CVS commit messages are blank - helpful to have a bit more information, even if it's just "Added a bit more code ..."
- this was highlighted in the previous exercise. Whilst I (AO'C) could the project to build and run from a cvs checkout as an Eclipse workbench project, I couldn't get it to run by dropping the [http://www.reload.ac.uk/beta/OpenDock_Plugin.zip plugin] into a download of [http://www.reload.ac.uk Reload] (Ubuntu Linux 7.04 Feisty Fawn).
AO'C - Alexis O'Connor.