forked from nus-cs2103-AY2425S1/tp
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #226 from woke02/branch-kelly-fix-docs-bugs
Fix Docs Bugs
- Loading branch information
Showing
8 changed files
with
75 additions
and
81 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,46 +1,40 @@ | ||
| --- | ||
| layout: default.md | ||
| title: "John Doe's Project Portfolio Page" | ||
| layout: default.md | ||
| title: "Kelly Wong's Project Portfolio Page" | ||
| --- | ||
|
|
||
| ### Project: AddressBook Level 3 | ||
| ### Project: HireMe | ||
|
|
||
| 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. | ||
| HireMe is a **desktop application for managing internship applications, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, HireMe can help you manage your internship tracking tasks faster than traditional GUI apps. | ||
|
|
||
| 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**: Architected and implemented a robust model schema, creating foundational model classes essential for application functionality. | ||
| * Details: Developed critical model classes, including `Company`, `Date`, `Email`, `InternshipApplication`, `Name`, `Role`, and `Status`, which serve as the building blocks for the entire model structure. | ||
| * Justification: These classes establish a scalable, clear, and maintainable framework, streamlining data flow and ensuring efficient data management across the application. This structured approach optimizes performance and paves the way for future feature expansion with minimal refactoring. | ||
|
|
||
| * **New Feature**: Added a history command that allows the user to navigate to previous commands using up/down keys. | ||
|
|
||
| * **Code contributed**: [RepoSense link]() | ||
| * **New Feature**: Added a status command to update the status of an internship application. | ||
| * What it does: Allows users to update the status of an internship application to `ACCEPTED`, `PENDING`, or `REJECTED`. | ||
| * Justification: This feature is crucial for tracking the current stage of each application, enabling users to keep organized records. | ||
|
|
||
| * **Project management**: | ||
| * Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub | ||
| * Managed releases `v1.3` and `v1.5` on GitHub, overseeing feature completeness and stability. | ||
|
|
||
| * **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]()) | ||
| * Added logging to improve future debugging processes. | ||
| * Ensured error messages are consistent across models to reduce ambiguity. | ||
| * Enhanced defensive programming by using assertions and exceptions for increased robustness. | ||
|
|
||
| * **Testing**: | ||
| * Added extensive test cases for the models and certain parser commands to ensure code reliability. | ||
|
|
||
| * **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}_ | ||
| * **User Guide**: | ||
| * Documented the `help`, `status`, `clear`, and `exit` features. | ||
| * Provided instructions on how to download and run the app. | ||
| * **Developer Guide**: | ||
| * Added implementation details for the `status` feature. | ||
| * Created sequence diagrams for `status` features. | ||
| * Added user stories for the `find` and `status` features. | ||
| * Added use cases for the `find` and `status` features. | ||
| * Created an activity diagram for the `status` feature. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters