OOP Project Template

doc/meetings/README.md

@@ -0,0 +1,15 @@
+# Meetings folder
+
+**Agenda**
+
+Before your weekly meeting you need to commit an agenda to this folder.
+
+Make sure that the filename follows the naming convention. 
+For instance, for February 13th you would use `20190213_agenda.xyz`.
+`xyz` would be the type of the file, please use either MarkDown (recommended, `.md` files) or PDFs (`.pdf`).
+
+**Meeting notes**
+
+After your weekly meeting you need to commit your notes in this folder.
+Please use the following naming convention: `20190213_notes.xyz` (where you change the date to the date of the meeting).
+Please hand in either a MarkDown or PDF file.

doc/reports/checkstyle/README.md

@@ -0,0 +1,5 @@
+# Checkstyle folder
+
+At the end of the week, please commit a readable screenshot that shows the Checkstyle results. 
+Make sure that the file follows the naming convention; `20190213_checkstyle.xyz` for February 13th.
+`.xyz` can be either `.jpg` or `.png`.

doc/reports/final-report/README.md

@@ -0,0 +1,9 @@
+# Final report folder
+
+This is where you commit a **PDF** version of the draft and the final version of your report.
+
+Checklist when handing in;
+
+- [ ] All your names and student numbers are visible on the report.
+- [ ] The filename is following the pattern `20190213_final_report.pdf` / `20190213_draft_final_report.pdf` (where the date is updated corresponding to the actual date).
+- [ ] Your final report is also uploaded to Brightspace.

doc/reports/sprint-reviews/README.md

@@ -0,0 +1,5 @@
+# Sprint review folder
+
+At the end of the week, please commit a PDF or MarkDown file containing your sprint review.
+Please use the following naming convention: `20190213_sprint_review.xyz` (update the date according to your current sprint).
+`.xyz` can be either `.pdf` or `.md`.

doc/reports/sprint-reviews/review-template.md

@@ -0,0 +1,18 @@
+<!-- An example of how you can do a sprint review -->
+
+# Sprint Review
+
+## Main problems  Encountered
+
+### Problem 1: Multiple members were too late
+During the lab, multiple people arrived too late. This interfered with the meeting that was scheduled at that moment and it had to be postponed.
+
+To mitigate this, a cake rule was added to push members to be on time
+
+## Adjustments from previous sprints
+ - Increase testing effort
+    - This was not achieved. New agreements have been made.
+
+## Adjustments for next sprint
+ - Increase testing effort
+ - Add cake rule

doc/sprint1/agenda.md

@@ -0,0 +1,56 @@
+# Meeting 1
+> Quoted text will give you extra pointers to how an agenda should look like
+
+## Opening
+> Here you check if everyone is present
+
+## Approval of the agenda
+> Make sure everything that needs to be discussed is in the agenda or add it if something is missing.
+
+## Points of action
+> The items below are things you should look into after the meeting. During the meeting you can divide (some of) the work between the team members, so that everybody has something to do afterwards.
+
+> Your TA will you for the meeting. Note down all other questions that you have so that you can ask them then.
+
+ - Create a planning and convert it to GitLab issues
+ - Discuss a cake rule: If you are late or not there at all, you have to bring cake (or something similar)
+ - Create a readme with your names, a picture and your personal development plan
+ - It is your job that you and your team contribute (equally)
+    - If there is a problem it is your responsibility to notify the TA
+ - Things to research:
+    - Scrum (See Brightspace) 
+        - Why should you use it?
+        - What is a scrum master?
+        - How are you going to use scrum in the team?
+        - How will you document the sprints? (tip: templates)
+        - Schedule for taking notes and chairing
+    - Git (See Brightspace)
+        - How does it work?
+        - What is branching?
+    - Maven (See Brightspace)
+        - What does it do?
+        - How do you add a library to the pom file?
+        - Have you set the team id?
+    - Code structure
+        - How will you use packages?
+    - Database options
+        - Json
+            - Gson
+            - Jackson
+        - SQL
+        - Plain text
+    - GUI
+        - JavaFX
+    - IDE
+        - Eclipse
+        - IntelliJ
+
+
+## Any other business
+> If anybody has something that should be discussed but came up with that after the agenda was finalized (in point 2), he/she should bring that up now so that it can be discussed after all.
+
+## Question round
+> If there are any questions, now is the time to ask them.
+
+## Closing
+> Now you can start working on the project. Good luck!