From 28014a0ebbd3cef6e20fb773b9533f4602710c8b Mon Sep 17 00:00:00 2001 From: tzw0 <42692203+tzw0@users.noreply.github.com> Date: Thu, 19 Sep 2019 14:59:02 +0800 Subject: [PATCH] Create zhengwen.adoc --- docs/team/zhengwen.adoc | 70 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 docs/team/zhengwen.adoc diff --git a/docs/team/zhengwen.adoc b/docs/team/zhengwen.adoc new file mode 100644 index 0000000000..c889f39db7 --- /dev/null +++ b/docs/team/zhengwen.adoc @@ -0,0 +1,70 @@ +John Doe - Project Portfolio +PROJECT: AddressBook - Level 3 +Overview +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. + +Summary of contributions +Major enhancement: 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} + +Minor enhancement: added a history command that allows the user to navigate to previous commands using up/down keys. + +Code contributed: [Functional code] [Test code] {give links to collated code files} + +Other contributions: + +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: + +Did cosmetic tweaks to existing contents of the User Guide: #14 + +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} + +Contributions to the User Guide +Given below are sections I contributed to the User Guide. They showcase my ability to write documentation targeting end-users. + +../UserGuide.adoc + +../UserGuide.adoc + +Contributions to the Developer Guide +Given below are sections I contributed to the Developer Guide. They showcase my ability to write technical documentation and the technical depth of my contributions to the project. + +../DeveloperGuide.adoc + +../DeveloperGuide.adoc + +PROJECT: PowerPointLabs +{Optionally, you may include other projects in your portfolio.}