-
Notifications
You must be signed in to change notification settings - Fork 95
Template Letter for Requesting a Review of a Model
Hi <--Name-->,
As a recent submitter to the Models Library, we'd like to request your help reviewing a new submission to the NetLogo Models Library: <--Model Name--> Is this something that you would have time to do? If not, just let me know and we can figure something else out.
If possible, could you please return the reviewed model to me by <--Two Weeks--> (earlier is better!)?
You should refer to the NetLogo style guide while reviewing. It's located here: https://github.com/NetLogo/models/wiki/Style-Guide.
If you have comments for the author that need to be "in-line", in either the code or info tabs, make sure to surround your comments by triple curly braces (e.g. {{{ comments }}}). This is so the model author can quickly search for any comments you might have.
You should be reviewing the model with the following three goals in mind:
- The code should be readable (e.g. well structured, well written, and well commented) and close-to-understandable by a person who is becoming familiar with NetLogo.
- The Info tab should succinctly and accurately describe the phenomenon being modeled. A reader who does not have any background in the subject should be able to at least garner some understanding of what is going on.
- The interface should be intuitive and it should be possible to use the model (at least tinker with it) without having to refer to the Info tab immediately.
In your review, which you can submit to us via email at czars@ccl.northwestern.edu, in addition to attaching your reviewed version of the model, please include:
- Any comments you have for me
- Any comments you have for the author (which I will forward along)
- Anything you think needs to be changed before the inclusion of the model in the models library
Feel free to let me know if you have any questions or concerns. If you don't have time to review a model right now, let me know and we can figure something out.
<--Signature-->
Models Library Editing
- Changes Since Previous Release
- Reviewing a Model for the Library
- Template Letter for Requesting a Review of a Model
- Automated Tests
- Resaving Models in the Newest Release
- Copyright and Citation Info
- Models Cross Referencing
- Models Library Statistics
- What is a Code Example?
- What is a Curricular Model?