-
Notifications
You must be signed in to change notification settings - Fork 5
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
Update NFR and Glossary in DeveloperGuide.md #34
Update NFR and Glossary in DeveloperGuide.md #34
Conversation
Add content to NFR and Glossary in Appendix: Requirements.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #34 +/- ##
=========================================
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me! 👍
but would like a second reviewer opinion to approve this
…ate-DeveloperGuide * 'master' of https://github.com/JerryWang0000/tp: Update file names to follow format Update aboutus page with my details and photo Update typos Change use case for filter and typo in sort aboutus update file name changed names to match github names update aboutus info to name match lowercase requirements Updated use cases Update AboutUs for Jerry Wang
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Just a few nits to fix..
9. A user without much experience in admin commands should be able to handle the usage in rather short time. | ||
*{More to be added}* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you might have missed out an empty line between this two lines. Currently the two lines have been combined into 1 line in the preview.
*{More to be added}* | ||
|
||
### Glossary | ||
|
||
* **Mainstream OS**: Windows, Linux, Unix, MacOS | ||
* **Private contact detail**: A contact detail that is not meant to be shared with others | ||
* **Users' Information**: Same as above |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps you could specify the possible information just like for Mainstream OS
where the OS are being listed down?
Add content to NFR and Glossary in Appendix: Requirements. As for the Glossary part, I don't really find much stuff worthy of recording, at least for now.