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

Update NFR and Glossary in DeveloperGuide.md #34

Conversation

JerryWang0000
Copy link
Collaborator

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.

Add content to NFR and Glossary in Appendix: Requirements.
Copy link

codecov bot commented Mar 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.26%. Comparing base (36404ac) to head (abeab66).
Report is 1 commits behind head on master.

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.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@whitesnowx whitesnowx left a 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

@whitesnowx whitesnowx changed the title Update NFR and Glossary in UserGuide.md Update NFR and Glossary in DeveloperGuide.md Mar 6, 2024
@whitesnowx whitesnowx added this to the v1.1 milestone Mar 6, 2024
…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
Copy link
Collaborator

@tsulim tsulim left a 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..

Comment on lines +405 to 406
9. A user without much experience in admin commands should be able to handle the usage in rather short time.
*{More to be added}*
Copy link
Collaborator

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
Copy link
Collaborator

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?

@JerryWang0000 JerryWang0000 deleted the update-DeveloperGuide branch March 7, 2024 04:55
@JerryWang0000 JerryWang0000 restored the update-DeveloperGuide branch March 7, 2024 04:55
@JerryWang0000 JerryWang0000 deleted the update-DeveloperGuide branch March 7, 2024 05:01
@tsulim tsulim added the type.Documentation Improvements or additions to documentation label Mar 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type.Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add glossary to the developer guide Add non-functional requirements to the developer guide
3 participants