Skip to content

Commit

Permalink
Merge branch 'master' into status-badge
Browse files Browse the repository at this point in the history
  • Loading branch information
liauzhanyi committed Oct 1, 2024
2 parents a81d00c + f31a2c2 commit f98d31c
Show file tree
Hide file tree
Showing 4 changed files with 111 additions and 30 deletions.
49 changes: 19 additions & 30 deletions docs/AboutUs.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,51 +11,40 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`

## Project team

### John Doe
### Andrew Teoh

<img src="images/johndoe.png" width="200px">
<img src="images/andrew22teoh.png" width="200px">

[[homepage](http://www.comp.nus.edu.sg/~damithch)]
[[github](https://github.com/johndoe)]
[[portfolio](team/johndoe.md)]

* Role: Project Advisor

### Jane Doe

<img src="images/johndoe.png" width="200px">

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

* Role: Team Lead
* Responsibilities: UI

### Johnny Doe

<img src="images/johndoe.png" width="200px">
### Abdulrahman Al Rammah
<img src="images/abdulrahmanalrammah.png" width="200px">

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

* Role: Developer
* Responsibilities: Data
* Responsibilities: Documentation

### Jean Doe
### Rayner Lim Fang Yuh

<img src="images/johndoe.png" width="200px">
<img src="images/rayray39.png" width="200px">

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

* Role: Developer
* Responsibilities: Dev Ops + Threading
* Responsibilities: UI

### James Doe
### Rachael Chan
<img src="images/rachael-chan.png" width="200px">

<img src="images/johndoe.png" width="200px">
[[github](http://github.com/rachael-chan)]
[[portfolio](team/rachaelchan.md)]

[[github](http://github.com/johndoe)]
[[portfolio](team/johndoe.md)]
* Role: Software Engineer
* Responsibilities: In charge of `Model`

* Role: Developer
* Responsibilities: UI
46 changes: 46 additions & 0 deletions docs/team/abdulrahmanalrammah.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
layout: default.md
title: "John Doe's Project Portfolio Page"
---

### Project: AddressBook Level 3

AddressBook - Level 3 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**: Added the ability to undo/redo previous commands.
* 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]()

* **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}_
46 changes: 46 additions & 0 deletions docs/team/andrew22teoh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
layout: default.md
title: "Andrew Teoh's Project Portfolio Page"
---

### Project: AddressBook Level 3

AddressBook - Level 3 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**: Added the ability to undo/redo previous commands.
* 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]()

* **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}_
Empty file added docs/team/rayray39.md
Empty file.

0 comments on commit f98d31c

Please sign in to comment.