How to submit an exercise or project
Hans Petter Langtangen (hpl at ifi.uio.no)
Exercises or projects are not accepted as email attachments
(because that is a too
inefficient procedure with storing and archiving files). Instead,
all files associated with exercises or projects must exist in some
Git repository on GitHub.
This is the way people work with software and technical documents
in 2016!
Delivery
Store all files related to an exericise or project
in a special directory with a logical name, located in
the root directory of your GitHub repository. (This repository
was automatically made for you in the beginning of INF5620.)
Checklist for peer review
Checklist for exercises
Hans Petter Langtangen (hpl at ifi.uio.no)
Students will in groups of three (or two) perform peer review, i.e.,
assess other students' exercises.
The review is written to a
file called FEEDBACK.txt, located in the student's exercise directory.
Below is a checklist of points to consider when writing a review.
For a program:
- Are the files easy to locate? That is, does the directory has a logical
name? Are individual files given names according to the exercise?
- Is the program easy to read? More specifically,
- Are variables given self-explanatory names or names in accordance
of the mathematical description?
- Are enough comments in the code?
- Is the code well formatted (use of whitespace etc.)?
- Is the code well organized in terms of functions or classes?
(Also consider overuse of functions and classes in simpler problems!)
Does the program answer the various points in the exercise?
Does the program work?
Are there any (automatic) verifications of the code?
Are you able to run the code?
For a report:
- Is the report easy to locate?
- Is the report well formatted (title, author, sections, paragraphs,
right spacings, low amount of typos, nice layout, introduction,
conclusions, etc.)?
- Is the text logic and easy to follow? Is there sufficient explanation of
what is done?
- Are the results correct?
- Are there any verifications of the results?
How to obtain a GitHub repository
(This is done once at the beginning of the course.)
- Go to github.com and create a user
- Fill out this form about your GitHub account
- In github, click on settings in the top right corner
- Go to emails
- Add your university email and verify it.
- Go to SSH keys and open the manual for creating a SSH key. Follow the manual.
- Go to education.github.com, click on Request a discount and fill out the form.
The course will automatically create a repository for you with a name
INF5620-yourname. You are supposed to put all your exercises and projects
in this repository. If you have any questions about this, please send an email to
inf5620@gmail.com.
A simple need-to-know intro to project hosting sites and version
control systems has been written: HTML document or PDF for printing).