[CS2103-T12-2] FumbleLog

.github/ISSUE_TEMPLATE/bug-report-template.md

@@ -0,0 +1,22 @@
+---
+name: Bug Report Template
+about: Template for Bug Reports
+title: ''
+labels: ''
+assignees: ''
+---
+
+## Details
+<!-- Enter bug details here -->
+
+## Steps to reproduce
+<!-- Enter steps to reproduce here -->
+
+## Expected behavior
+<!-- What should the expected behaviour be -->
+
+## Actual behavior
+<!-- What should the actual behaviour? -->
+
+## Screenshots
+<!-- Screenshots if necessary -->

.github/ISSUE_TEMPLATE/user-story-template.md

@@ -0,0 +1,14 @@
+---
+name: User stories Template
+about: Template for User stories
+title: ''
+labels: ''
+assignees: ''
+---
+
+## User stories
+- [Insert user stories here]
+
+## Details
+- [Insert details here]
+  - Format: [insert format if necessary]

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,17 @@
+## Description
+
+<!-- Briefly describe the purpose of this pull request. -->
+
+## Context
+
+<!-- Provide context or link to related issues, discussions, or documentation. -->
+
+## Checklist
+
+- [ ] I have self-reviewed my changes.
+- [ ] I have added JavaDocs to all relevant methods.
+- [ ] I have updated the documentation:
+    - User Guide Table of Contents, Description and Summary.
+    - Developer Guide, if applicable.
+- [ ] I have ran `./gradlew test` or `./gradlew check` and all checks pass.
+- [ ] I have updated my project portfolio with what I have contributed.

.gitignore

@@ -2,6 +2,7 @@
 /.gradle/
 /build/
 src/main/resources/docs/
+/bin/
 
 # IDEA files
 /.idea/
@@ -21,3 +22,6 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+
+# jar files
+*.jar

README.md

@@ -1,14 +1,17 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+[![CI Status](https://github.com/AY2324S1-CS2103T-T12-1/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S1-CS2103T-T12-2/tp/actions)
+[![codecov](https://codecov.io/gh/AY2324S1-CS2103T-T12-2/tp/graph/badge.svg?token=MDL2TF28EC)](https://codecov.io/gh/AY2324S1-CS2103T-T12-2/tp)
+## FumbleLog
+![Ui](docs/images/Ui.png) 
 
-![Ui](docs/images/Ui.png)
+FumbleLog is a **productivity desktop application** built to for **NUS Computing students** to help you manage contacts and track events.
+It is designed to be an easy-to-use, one-stop platform for all your scheduling needs.
 
-* This is **a sample project for Software Engineering (SE) students**.<br>
-  Example usages:
-  * as a starting point of a course project (as opposed to writing everything from scratch)
-  * as a case study
-* The project simulates an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details.
+* If you are interested in using FumbleLog, head over to the [_Quick Start_ section of the **User Guide**](docs/UserGuide.md#quick-start).
+* If you are interested about developing FumbleLog, the [**Developer Guide**](docs/DeveloperGuide.md) is a good place to start.
+
+The project simulates an ongoing software project for a desktop application (called _FumbleLog_) used for managing contact details.
   * It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big.
   * It comes with a **reasonable level of user and developer documentation**.
-* It is named `AddressBook Level 3` (`AB3` for short) because it was initially created as a part of a series of `AddressBook` projects (`Level 1`, `Level 2`, `Level 3` ...).
-* For the detailed documentation of this project, see the **[Address Book Product Website](https://se-education.org/addressbook-level3)**.
-* This project is a **part of the se-education.org** initiative. If you would like to contribute code to this project, see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info.
+
+* For the detailed documentation of this project, see the **[FumbleLog Product Website](https://ay2324s1-cs2103t-t12-2.github.io/tp/)**.
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -25,6 +25,10 @@ test {
     finalizedBy jacocoTestReport
 }
 
+run {
+    enableAssertions = true
+}
+
 task coverage(type: JacocoReport) {
     sourceDirectories.from files(sourceSets.main.allSource.srcDirs)
     classDirectories.from files(sourceSets.main.output)
@@ -66,7 +70,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'fumblelog.jar'
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -5,55 +5,56 @@ title: About Us
 
 We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
 
-You can reach us at the email `seer[at]comp.nus.edu.sg`
+You can visit our project repository at our [organisation github](https://github.com/AY2324S1-CS2103T-T12-2).
 
 ## Project team
 
-### John Doe
+### Lee Zheng Jing
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/leezhengjing.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/leezhengjing)]
+[[portfolio](team/leezhengjing.md)]
 
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: Data
 
-### Jane Doe
+### Kurt Lee Yi Jie
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/kurtyjlee.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/Kurtyjlee)]
+[[portfolio](team/kurtyjlee.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Back-end and QA
 
-### Johnny Doe
+### Leong Yu Jun Nicholas
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/nicleongyj.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](https://github.com/nicleongyj)]
+[[portfolio](team/nicleongyj.md)]
 
 * Role: Developer
 * Responsibilities: Data
 
-### Jean Doe
+### Guo Yuheng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/distractedcat.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/DistractedCat)]
+[[portfolio](team/distractedcat.md)]
 
 * Role: Developer
 * Responsibilities: Dev Ops + Threading
 
-### James Doe
+### Lai Wei Zhong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/ken-lai.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/Ken-Lai)]
+[[portfolio](team/ken-lai.md)]
 
 * Role: Developer
 * Responsibilities: UI