README.md 2.59 KB
Newer Older
Albin Severinson's avatar
Albin Severinson committed
1
# [Obligatory Assignment 2: “Battleship”](https://retting.ii.uib.no/inf101.v19.sem2/blob/master/SEM-2.md)
Anya Helene Bagge's avatar
initial  
Anya Helene Bagge committed
2 3 4


* **README**
Albin Severinson's avatar
Albin Severinson committed
5
* [Assignment instructions](SEM-2.md)
Anya Helene Bagge's avatar
initial  
Anya Helene Bagge committed
6

Albin Severinson's avatar
Albin Severinson committed
7
This project contains [obligatory assignment 2](SEM-2.md). You can also [read the assignment instructions online](https://retting.ii.uib.no/inf101.v19.oppgaver/inf101.v19.sem2/blob/master/SEM-2.md) (may contain small updates that aren't in your local copy).
Anya Helene Bagge's avatar
initial  
Anya Helene Bagge committed
8

Albin Severinson's avatar
Albin Severinson committed
9
**Deadline:**
Noeska Smit's avatar
Noeska Smit committed
10
* The entire assignment has to be handed in by **Friday the 26th of April 23:59** 
Noeska Smit's avatar
Noeska Smit committed
11
* [Tips for a smooth(er) hand-in (same as for SEM-1)](https://retting.ii.uib.no/inf101/inf101.v19/wikis/innlevering)
Anya Helene Bagge's avatar
initial  
Anya Helene Bagge committed
12

Noeska Smit's avatar
Noeska Smit committed
13
**You have to indicate which parts of the assignment you've completed and if the assignment is ready for grading in the section below in your README.md.**
Anya Helene Bagge's avatar
initial  
Anya Helene Bagge committed
14

Noeska Smit's avatar
Noeska Smit committed
15
**Extension:** You can ask the teaching assistants for a deadline extension if needed. You should already have completed parts of the assignment and pushed these to the repository at before the deadline when asking for an extension.
Albin Severinson's avatar
Albin Severinson committed
16
   * A day or two extension is fine without motivation.
Noeska Smit's avatar
Noeska Smit committed
17
   * For longer extensions, we need a concrete reason for the delay. Please also contact us if there are [other things we need to consider](http://www.uib.no/student/49241/trenger-du-tilrettelegging-av-ditt-studiel%C3%B8p).
Albin Severinson's avatar
Albin Severinson committed
18

Noeska Smit's avatar
Noeska Smit committed
19 20
# Progress report - Please add answers/descriptions/comments to your project below 
* Assignment by: *NAME* (*abc123*)
Albin Severinson's avatar
Albin Severinson committed
21
* [ ] Assignment is ready for grading!
Anya Helene Bagge's avatar
initial  
Anya Helene Bagge committed
22
* Code review:
Albin Severinson's avatar
Albin Severinson committed
23 24
   * [ ] I've received feedback from @username, ...
   * [ ] I've given feedback to @username, ...
Noeska Smit's avatar
Noeska Smit committed
25 26 27
* Checklist:
   * [ ] A playable Battleship game
   * [ ] Explanation and motivation for how the game is implemented, e.g., design decisions, how the code is organized, what abstractions are used, etc.
Albin Severinson's avatar
Albin Severinson committed
28 29 30 31
   * [ ] Tests
   * [ ] Documentation (JavaDoc, comments, diagrams, README, etc.)
   * [ ] Carefully named classes, interfaces, methods and variables.
   * [ ] Carefully chosen abstractions and encapsulation (use of classes, interfaces, methods, etc).
Anya Helene Bagge's avatar
initial  
Anya Helene Bagge committed
32

Noeska Smit's avatar
Noeska Smit committed
33
### Running instructions
Albin Severinson's avatar
Albin Severinson committed
34 35 36 37 38 39 40
* To play the game, run: `class.name.here`

## Overview
*(overview of your code and what you've done)*

## Design Choices
*(how you've chosen to complete the assignment)*
Anya Helene Bagge's avatar
initial  
Anya Helene Bagge committed
41

Albin Severinson's avatar
Albin Severinson committed
42 43 44
### Abstractions
*(how elements of the game are represented by classes/objects)*

Noeska Smit's avatar
Noeska Smit committed
45
### Lessons learned
Albin Severinson's avatar
Albin Severinson committed
46 47 48 49
*(What choices turned out to work well or less well? Is there something you'd have done differently?)*

## Testing
*(how have you tested your implementation?)*
Anya Helene Bagge's avatar
initial  
Anya Helene Bagge committed
50

Albin Severinson's avatar
Albin Severinson committed
51
## Features / Bugs
Noeska Smit's avatar
Noeska Smit committed
52
*(what works and doesn't work)*
Anya Helene Bagge's avatar
initial  
Anya Helene Bagge committed
53

Noeska Smit's avatar
Noeska Smit committed
54 55
## Code review experience
*(did you learn anything from review of your code or someone else's code?)*