Add 3 new uses cases (add home-buyer, add homes and view home-seller based on priority), update non-functional requirements and glossary #32
Conversation
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
* 'master' of https://github.com/KhoonSun47/tp: Update EstateEase Developer Guide
* 'master' of https://github.com/KhoonSun47/tp: Update use case UC02: View All
* 'master' of https://github.com/KhoonSun47/tp: Add UC04 to the developer guide
* master: Add UC04 to the developer guide Update use case UC02: View All
- Update DeveloperGuide.md: Add 3 new uses cases (add home-buyer, add homes and view home-seller based on priority) and edit current use case (add home-seller), update non-functional requirements and glossary
KhoonSun47
requested review from
limcaaarl,
redcolorbicycle,
zengzihui and
felixchanyy
limcaaarl
requested changes
Mar 6, 2024
docs/DeveloperGuide.md
Outdated
| * 3k1. EstateEase shows an error message regarding the entry of incorrect role. <br> | ||
| Use case resumes from step 2. | ||
|
|
||
| **Use case: UC00 - Add more homes to home-seller** |
There was a problem hiding this comment.
😂I think renumber all the UC instead. First one should be UC01 not UC00.
There was a problem hiding this comment.
Yeap updated the numbering of the use case. Thanks for reminding.
docs/DeveloperGuide.md
Outdated
| * 3k1. EstateEase shows an error message regarding incorrect format for postal code. <br> | ||
| Use case resumes from step 2. | ||
|
|
||
| **Use case: UC00 - Viewing of homes based on home-seller's priority** |
There was a problem hiding this comment.
Yeap updated the numbering of the use case. Thanks for reminding.
docs/DeveloperGuide.md
Outdated
| @@ -385,6 +388,145 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli | |||
| * 3q1. EstateEase shows an error message regarding the entry of incorrect priority level. <br> | |||
| Use case resumes from step 2. | |||
|
|
|||
| **Use case: UC00 - Add home-buyer to user’s contact list** | |||
There was a problem hiding this comment.
Yeap updated the numbering of the use case. Thanks for reminding.
Update DeveloperGuide.md: Update use cases numbering in ascending format
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #32 +/- ##
=========================================
Coverage 75.26% 75.26%
Complexity 419 419
=========================================
Files 71 71
Lines 1338 1338
Branches 126 126
=========================================
Hits 1007 1007
Misses 301 301
Partials 30 30 ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The developer guide lacks information about new use cases. Hence, adding new use cases ensures that developers have comprehensive documentation about the system's functionality.
The new use cases include adding home-buyer, adding homes and viewing home-seller based on priority.
Non-functional requirements and glossary are also added, so that the developers have a comprehensive understanding of the system's performance, security, usability, and other operational characteristics, in addition to a clear reference for technical terms used throughout the documentation.