Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated portfolio and test case #246

Merged
merged 4 commits into from
Nov 11, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
31 changes: 19 additions & 12 deletions docs/team/chuazhenwei.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,12 @@ CHRS is capable of checking work schedule, creating recruitment posts, checking

== 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}_
* *Major enhancement*: added `modifyPay` and `modifyAllPay` command
** What it does: allows the user to modify the salary and bonus of the employees. Additionally, the `modifyAllPay` command enhance the functionality of `modifyPay` command by enabling the user to modify the salary and bonus of every employees shown in the list.
** Justification: This feature improves the product significantly because the user can indicate the changes to be made to the employee(s) salary based on values or percentage, and to the bonus based on months of salary.
** Highlights: These commands enhance the users experience in dealing with payroll due to the functionality to modify the salary and bonus just by indicating the value or percentage for salary, and number of months for bonus without having to calculate themselves which reduce chances for human error.

* *Minor enhancement*: added a history command that allows the user to navigate to previous commands using up/down keys.

* *Code contributed*: [https://github.com[Functional code]] [https://github.com[Test code]] _{give links to collated code files}_
* *Code contributed*: [https://nuscs2113-ay1819s1.github.io/dashboard/#=undefined&search=chuazhenwei&sort=displayName&since=2018-09-12&until=2018-11-04&timeframe=day&reverse=false&repoSort=true[Reposense Dashboard]]

* *Other contributions*:

Expand All @@ -43,16 +40,25 @@ CHRS is capable of checking work schedule, creating recruitment posts, checking
*** Integrated a third party library (Natty) to the project (https://github.com[#42])
*** Integrated a new Github plugin (CircleCI) to the team repo

_{you can add/remove categories in the list above}_
** Documentation:
*** Updated Developer Guide on `modifyPay` feature, UI component diagram and instruction for manual testing. (Pull requests: https://github.com/CS2113-AY1819S1-T16-4/main/pull/105[#105], https://github.com/CS2113-AY1819S1-T16-4/main/pull/231/files[#231], https://github.com/CS2113-AY1819S1-T16-4/main/pull/241[#241])
*** Updated User Guide to ensure information are up to date. (Pull requests: https://github.com/CS2113-AY1819S1-T16-4/main/pull/2[#2], https://github.com/CS2113-AY1819S1-T16-4/main/pull/4/files[#4], https://github.com/CS2113-AY1819S1-T16-4/main/pull/17/files[#17], https://github.com/CS2113-AY1819S1-T16-4/main/pull/19[#19],
https://github.com/CS2113-AY1819S1-T16-4/main/pull/112[#112], https://github.com/CS2113-AY1819S1-T16-4/main/pull/170[#170], https://github.com/CS2113-AY1819S1-T16-4/main/pull/173[#173], https://github.com/CS2113-AY1819S1-T16-4/main/pull/187[#187], )

== Contributions to the User Guide
** Community:
*** PRs reviewed (With non-trivial comments) (Pull requests: https://github.com/CS2113-AY1819S1-T16-4/main/pull/73[#73], https://github.com/CS2113-AY1819S1-T16-4/main/pull/74[#74], https://github.com/CS2113-AY1819S1-T16-4/main/pull/76[#76], https://github.com/CS2113-AY1819S1-T16-4/main/pull/120[#120],
https://github.com/CS2113-AY1819S1-T16-4/main/pull/133[#133], https://github.com/CS2113-AY1819S1-T16-4/main/pull/136[#136], https://github.com/CS2113-AY1819S1-T16-4/main/pull/137[#137], https://github.com/CS2113-AY1819S1-T16-4/main/pull/139[#139], https://github.com/CS2113-AY1819S1-T16-4/main/pull/140[#140])
*** Reported bugs and suggestions for other teams in the class (examples: https://github.com/CS2113-AY1819S1-W12-2/main/issues/100[1], https://github.com/CS2113-AY1819S1-W12-2/main/issues/105[2], https://github.com/CS2113-AY1819S1-W12-2/main/issues/110[3], https://github.com/CS2113-AY1819S1-W12-2/main/issues/114[4],
https://github.com/CS2113-AY1819S1-W12-2/main/issues/119[5], https://github.com/CS2113-AY1819S1-W12-2/main/issues/123[6], https://github.com/CS2113-AY1819S1-W12-2/main/issues/135[7])

== 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._
|===

include::../UserGuide.adoc[tag=undoredo]
include::../UserGuide.adoc[tag=modifyPayCommand]
include::../UserGuide.adoc[tag=modifyAllPayCommand]


== Contributions to the Developer Guide
Expand All @@ -61,7 +67,8 @@ include::../UserGuide.adoc[tag=undoredo]
|_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._
|===

include::../DeveloperGuide.adoc[tag=undoredo]
include::../DeveloperGuide.adoc[tag=modifyPay]
include::../DeveloperGuide.adoc[tag=casper]


== PROJECT: PowerPointLabs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -338,9 +338,11 @@ public void equals() {

// same object -> returns true
assertTrue(standardCommand.equals(standardCommand));
assertTrue(copyDescriptor.equals(copyDescriptor));

// null -> returns false
assertFalse(standardCommand == null);
assertFalse(standardCommand.equals(null));
assertFalse(copyDescriptor.equals(null));

// different types -> returns false
assertFalse(standardCommand.equals(new ClearCommand()));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -340,9 +340,11 @@ public void equals() {

// same object -> returns true
assertTrue(standardCommand.equals(standardCommand));
assertTrue(copyDescriptor.equals(copyDescriptor));

// null -> returns false
assertFalse(standardCommand == null);
assertFalse(standardCommand.equals(null));
assertFalse(copyDescriptor.equals(null));

// different types -> returns false
assertFalse(standardCommand.equals(new ClearCommand()));
Expand Down