Skip to content

Commit

Permalink
Merge branch 'master' into ug-known-issue-ui-bug
Browse files Browse the repository at this point in the history
  • Loading branch information
lithops-zty authored Nov 11, 2024
2 parents 5563c21 + b1d2e3c commit c791d06
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 28 deletions.
13 changes: 11 additions & 2 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -739,8 +739,7 @@ hence reducing the usefulness of this command.
This limitation is due to our current system design which forces a role type to be assigned to an exact module code into the search query for the find command to execute,
we plan to adopt other ways of constructing the query to allow for more general search of module-role in the future.

2. **Allow deletion of other optional data fields of a contact, using the current edit command approach.** Currently, only the description and tag fields of a contact can be deleted, by editing the contact description field with
an empty string (For Example: `edit 9 d/` removes description of the ninth contact in the current list), and not any other optional fields such as phone, email and address.
2. **Allow deletion of other optional data fields of a contact, using the current edit command approach.** Currently, only the description and tag fields can be deleted, by specifying the corresponding prefix followed by an empty string (For Example: `edit 9 t/` removes all tags, while `edit 9 d/` removes the description of the ninth contact in the current list). However, other optional fields such as the phone, email and address cannot be removed as of v1.6.

![point2_screenshot_remove_description_example](images/Planned_Enhancements_Screenshots/Point2_RemoveDescriptionExample.png)
(As shown in the screenshot, `edit 9 d/` successfully removes description field from the ninth person in the current list.)
Expand All @@ -753,3 +752,13 @@ This can be very troublesome to user if he/she accidentally adds these fields to
If these fields are left unchanged over a long period of time, user may forget that these fields are wrong and hence use the wrong information in the program, which is definitely
not desired. We plan to allow edit command to accept empty input for phone, email and address and change the parser such that the empty inputs for these fields can be considered as
deleting them from the selected contact.

4. **Enforce realistic role assignment for contacts.** Currently, a contact can have multiple roles, such as both "Professor" and "Student".
This is unrealistic, as an individual is typically either a student or a professor, but not both.

![point4_screenshot](images/Planned_Enhancements_Screenshots/Point4_ConflictingRoleExample.png)<br>
(As shown in the screenshot, Royston is both a CS1101S professor and CS2100 student.)

We plan to enforce stricter role assignment, ensuring that:
* A contact can be designated as a Professor across multiple modules.
* Alternatively, a contact can be designated as either a Student or a Tutor across multiple modules.
8 changes: 3 additions & 5 deletions docs/SettingUp.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,9 @@ If you plan to use Intellij IDEA (highly recommended):

When you are ready to start coding, we recommend that you get some sense of the overall design by reading about [ContactCS’s architecture](DeveloperGuide.md#architecture).

<!---
1. **Do the tutorials**
These tutorials will help you get acquainted with the codebase.

* [Tracing code](tutorials/TracingCode.md)
* [Adding a new command](tutorials/AddRemark.md)
* [Removing fields](tutorials/RemovingFields.md)
-->
* [Tracing code](https://se-education.org/guides/tutorials/ab3TracingCode.html)
* [Adding a new command](https://se-education.org/guides/tutorials/ab3AddRemark.html)
* [Removing fields](https://se-education.org/guides/tutorials/ab3RemovingFields.html)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
41 changes: 20 additions & 21 deletions docs/team/lithops-zty.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,38 +9,37 @@ AddressBook - Level 3 is a desktop address book application used for teaching So

Given below are my contributions to the project.

* **New Feature**: Added the ability to undo/redo previous commands.
* **New Feature**: Added the ability to undo/redo previous commands, together with [Eline](elinengu.md).
* 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}*
* 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. This is especially the case when the user accidentally `clear`s the entire address book.
* Highlights: This enhancement affects existing commands and commands to be added in the future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it interacts with many components of the app.
* Credits: [Eline](elinengu.md) and I implemented the feature based on the *Proposed Features* section of AB3. I also wrote the tests for the feature.

* **New Feature**: Added a history command that allows the user to navigate to previous commands using up/down keys.
* **New Feature**: Added the ability to delete module roles using the `edit` command.

* **Code contributed**: [RepoSense link]()
* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2425s1.github.io/tp-dashboard/?search=lithops-zty&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2024-09-20&tabOpen=true&tabType=authorship&tabAuthor=lithops-zty&tabRepo=AY2425S1-CS2103T-F12-1%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false)

* **Project management**:
* Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub
* Managed releases `v1.3`, `v1.5`, `v1.5.1`, `v1.6` on GitHub.
* Refined the color scheme of GitHub issue labels.

* **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 the ability to further filter the previous find results using `find chained`
* Allowed the `find` command to perform a partial match on names.
* Made the error messages of `find` and `delete` more specific.
* Included the exact fields edited in the `edit` command's success message.

* **Documentation**:
* User Guide:
* Added documentation for the features `delete` and `find` [\#72]()
* Did cosmetic tweaks to existing documentation of features `clear`, `exit`: [\#74]()
* Added documentation for the feature delete module role.
* Updated the documentation for the `find` command.
* Updated the repetition syntax.
* Developer Guide:
* Added implementation details of the `delete` feature.
* Added the sequence diagrams for the `find` command.
* Updated the diagrams for undo/redo.
* Updated the `Model`'s class diagram to include the `VersionedAddressBook` class.

* **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]())
* 40 PRs reviewed
* Contributed to forum discussions (examples: [1](https://github.com/nus-cs2103-AY2425S1/forum/issues/2), [2](https://github.com/nus-cs2103-AY2425S1/forum/issues/165), [3](https://github.com/nus-cs2103-AY2425S1/forum/issues/495))

* **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}_

0 comments on commit c791d06

Please sign in to comment.