Skip to content

Commit

Permalink
Merge branch 'master' into branch-Update-website-config
Browse files Browse the repository at this point in the history
  • Loading branch information
junhonglow committed Oct 8, 2023
2 parents 9d9f3b1 + 0861042 commit 48f2553
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 15 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
[![Java CI](https://github.com/AY2324S1-CS2103-F13-4/tp/actions/workflows/gradle.yml/badge.svg?branch=master)](https://github.com/AY2324S1-CS2103-F13-4/tp/actions/workflows/gradle.yml)

![Ui](docs/images/Ui.png)

* 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.
* 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.


**UniMate** is a powerful desktop application designed to streamline contact and events management.
Users can effortlessly manage their contacts, schedule events, and keep track of important information, all in one place.

* For the detailed documentation of this project, see the **[UniMate Product Website](https://ay2324s1-cs2103-f13-4.github.io/tp/)**.
* If you are interested about developing UniMate, the **[Developer Guide](https://ay2324s1-cs2103-f13-4.github.io/tp/DeveloperGuide.html) is a good place to start.

### Acknowledgements
- This project is forked from the AddressBook-Level3 project created by [SE-EDU initiative](https://se-education.org).
4 changes: 2 additions & 2 deletions docs/AboutUs.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This project was done by a team of 4 members.
<img src="images/lihongguang00.png" width="200px">

[[github](https://github.com/lihongguang00)]
[[portfolio](team/johndoe.md)]
[[portfolio](team/lihongguang00.md)]

- Role: Team Member
- Responsibilities: TBD
Expand All @@ -36,7 +36,7 @@ This project was done by a team of 4 members.
<img src="images/junhonglow.png" width="200px">

[[github](http://github.com/junhonglow)]
[[portfolio](team/johndoe.md)]
[[portfolio](team/junhonglow.md)]

- Role: Developer
- Responsibilities: TBD
Expand Down
46 changes: 46 additions & 0 deletions docs/team/junhonglow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
layout: page
title: John Doe's Project Portfolio Page
---

### Project: UniMate

UniMate is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.

Given below are my contributions to the project.

* **New Feature**: To be determined
* What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command.
* Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them.
* Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands.
* Credits: *{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}*

* **New Feature**: Added a history command that allows the user to navigate to previous commands using up/down keys.

* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code&since=2023-09-22&tabOpen=true&tabType=zoom&zA=junhonglow&zR=AY2324S1-CS2103-F13-4%2Ftp%5Bmaster%5D&zACS=104.16170212765958&zS=2023-09-22&zFS=&zU=2023-10-05&zMG=false&zFTF=commit&zFGS=groupByRepos&zFR=false)

* **Project management**:
* Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub

* **Enhancements to existing features**:
* Updated the GUI color scheme (Pull requests [\#33](), [\#34]())
* Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests [\#36](), [\#38]())

* **Documentation**:
* User Guide:
* Added documentation for the features `delete` and `find` [\#72]()
* Did cosmetic tweaks to existing documentation of features `clear`, `exit`: [\#74]()
* Developer Guide:
* Added implementation details of the `delete` feature.

* **Community**:
* PRs reviewed (with non-trivial review comments): [\#12](), [\#32](), [\#19](), [\#42]()
* Contributed to forum discussions (examples: [1](), [2](), [3](), [4]())
* Reported bugs and suggestions for other teams in the class (examples: [1](), [2](), [3]())
* Some parts of the history feature I added was adopted by several other class mates ([1](), [2]())

* **Tools**:
* Integrated a third party library (Natty) to the project ([\#42]())
* Integrated a new Github plugin (CircleCI) to the team repo

* _{you can add/remove categories in the list above}_
4 changes: 2 additions & 2 deletions docs/team/johndoe.md → docs/team/lihongguang00.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: default.md
title: "John Doe's Project Portfolio Page"
title: "Hongguang's Project Portfolio Page"
---

### Project: AddressBook Level 3
Expand All @@ -17,7 +17,7 @@ Given below are my contributions to the project.

* **New Feature**: Added a history command that allows the user to navigate to previous commands using up/down keys.

* **Code contributed**: [RepoSense link]()
* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=lihongguang00%20&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code&since=2023-09-22&tabOpen=true&tabType=authorship&zFR=false&tabAuthor=lihongguang00&tabRepo=AY2324S1-CS2103-F13-4%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false)

* **Project management**:
* Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub
Expand Down

0 comments on commit 48f2553

Please sign in to comment.