Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/neyapraveen/tp
Browse files Browse the repository at this point in the history 
* 'master' of https://github.com/neyapraveen/tp: (40 commits)
  Edit UG
  Fix Ug bug
  Edit UG
  Fix UG documentation bug
  Edit UG
  Edit UG
  Edit UG
  Edit UG
  Edit UG
  Edit UG
  Edit UG
  Edit UG
  Edit UG
  Edit UG
  Fix dg
  Edit UG
  Fix formatting for back to table
  Edit doc
  Edit doc
  Edit ppp
  ...
  • Loading branch information
@neyapraveen
neyapraveen committed Nov 13, 2023
2 parents 014becf + 048f2e5 commit 8a87b50
Show file tree
Hide file tree
Showing 10 changed files with 168 additions and 185 deletions.
3 changes: 1 addition & 2 deletions docs/DeveloperGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ title: Developer Guide

## **Acknowledgements**

* {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
* This project is based on the AddressBook-Level3 project created by the [**SE-EDU initiative**](https://se-education.org).
This project is based on the AddressBook-Level3 project created by the [**SE-EDU initiative**](https://se-education.org).

--------------------------------------------------------------------------------------------------------------------

Expand Down
165 changes: 103 additions & 62 deletions docs/UserGuide.md
View file

Large diffs are not rendered by default.

18 changes: 4 additions & 14 deletions docs/team/maj0-0.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ title: Majedah's Project Portfolio Page
StudentConnect is the solution for hassle-free team formation for CS2103T students to browse profiles and connect with others for group projects.

# Summary of Contributions
Given below are my contributions to StudentConnect.

## Code contributed
* Link to my [RepoSense report](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=maj0-0&breakdown=false&sort=groupTitle%20dsc&sortWithin=title&since=2023-09-22&timeframe=commit&mergegroup=&groupSelect=groupByRepos).
Expand All @@ -24,16 +23,6 @@ Given below are my contributions to StudentConnect.
* **Enhancement**: List Command
* Updated the list students feature's success message to match StudentConnect context.

## Contributions to testing
* Implemented test cases for the `Tutorial` class.
* Updated test cases that involve the Person model to include tutorial.
* Implemented test cases for the `Nationality` and `Gender` classes.
* Updated test cases that involve the Person model to include nationality and gender.
* Added gender and nationality to `TypicalPersons`.
* Implemented test cases for tasks command and parser.
* Included `TypicalTasks` to be used for testing


## Contributions to the UG
* Under student commands and command summary, the 'list' portion.
* Under group commands and command summary, the 'tasks' portion.
Expand All @@ -52,11 +41,12 @@ Given below are my contributions to StudentConnect.

## Contributions to team-based tasks
* Did equal share of tasks assigned.
* Ensured JAR releases were ready when needed.
* Filmed and edited the product demo.
* Brainstormed and suggested new features during each milestone.
* Ensured all team deliverables were met in time.

## Review / mentoring contributions
* Reviewed teammates' PRs and gave suggestions when appropriate.

## Contributions beyond the project team
* Brainstormed and suggested new features during each milestone.
* Ensured all team deliverables were met in time.
* Identified and assessed bugs in other teams' projects.
52 changes: 17 additions & 35 deletions docs/team/neyapraveen.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ title: Neya's Project Portfolio Page
StudentConnect is the solution for hassle-free team formation for CS2103T students to browse profiles and connect with others for group work.

# Summary of Contributions
Given below are my contributions to the project.

## Code contributed
* Link to my [Reposense Report](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=neya&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code&since=2023-09-22)
Expand All @@ -16,58 +15,41 @@ Given below are my contributions to the project.
* **Enhancement**: Changed `delete` feature to delete by email rather than by index.
* **Enhancement**: Redid the UI, making styling decisions such as colour scheme, fonts.
* **Enhancement**: Edited UI for GroupListPanel, so it would resemble PersonListPanel.
* **New Feature**: Added hyperlinks to the social media field, so users can open the urls in a browser by clicking on them.
* **New Feature**: Added hyperlinks to the social media field, so users can open the urls in a browser.
* **New Feature**: Implemented the `deleteGroup` command.
* **New Feature**: Implemented the `leave` command.
* **New Feature**: Added basic task classes for `Todo`, `Deadlines` and `Tasklist` before implementation of the task related functions.
* **New Feature**: Added classes for `Todo`, `Deadlines` and `Tasklist` before implementation of task functions.
* **New Feature**: Implemented and styled a confirmation pop-up for clear command (including css).

## Contributions to testing
* Changed test cases pertaining to `delete` feature.
* Changed test cases pertaining to `delete` feature, `clear` feature.
* Created a `JavaFXInitialiser` to be used for fx and ui related tests.
* Implemented `PersonCardTest`.
* Added test cases pertaining to the `deleteGroup` command.
* Added test cases for the `leave` command.
* Updated `clear` test cases.
* Implemented `PersonCardTest`.`deleteGroupCommandTest`, `deleteGroupCommandParserTest`, `leaveCommandTest`, `leaveCommandParserTest`.

## Contributions to the UG
* Added documentation for the feature `delete`
* Creation of Table of Contents
* Added documentation for social media hyperlinks
* Added documentation for the feature `clear`, including the usage of the pop-up
* Reformatted UG according to general commands, person commands and group commands
* Added documentation for the feature `leave`
* Added documentation for the feature `deleteGroup`
* Created the Appendix section.
* Wrote introduction section.
* Added page breaks for formatting.
* Added back to table of contents hyperlink at the end of pages.
* Added relevant hyperlinks like download link for java 11.
* Added relevant warning messages on things to look out for.
* Added documentation for the feature `delete`, `clear`, including the usage of the pop-up, `leave`, `deleteGroup` and social media hyperlinks.
* Created Table of Contents.
* Reformatted UG according to general commands, person commands and group commands.
* Wrote the Introduction section and created the Appendix section.
* Added page breaks for formatting and back to table of contents hyperlink at the end of pages.
* Added relevant hyperlinks like download link for java 11 and warning messages.
* Added hyperlinks of glossary terms.

## Contributions to the DG
* Updated initial contents in DG after discussion(target user profile, value proposition, user stories, use cases, NFRs, Glossary )
* Under Use-cases, `Delete a student`
* Under Use-cases, `Access social media`
* Under Use-cases, `Clearing all data`
* Under Use-cases, `Delete a group`
* Under Use-cases, `Leave a group`
* Updated initial contents in DG after discussion(target user profile, value proposition, user stories, use cases, NFRs, Glossary).
* Under Use-cases, `Delete a student`, `Access social media` , `Clearing all data`, `Delete a group`, `Leave a group`.
* Add relevant user stories for clear, delete group, leave group, social media links, delete.
* Rearranged all use cases.
* Numbered all use cases for easy reference.
* Rearranged all use cases and numbered all for easy reference.
* Added sequence diagram using PlantUML.

## Contributions to team-based tasks
* Did equal share of tasks assigned.
* Wrote intro and Brainstormed ideas for features for further iterations.

## Review/ mentoring contributions
* Reviewed teammates' PRs and gave suggestions when appropriate.
* Helped with teammates' UI.
* Helped in debugging.
* Ensured code quality, helped in adding javadocs.
* Helped with teammates' UI and debugging, ensured code quality, helped in adding javadocs.

## Contributions beyond the project team
* Brainstormed ideas for features and further iterations.
* Participated in load testing.
* Helped in finding other group's bugs during PED.
* Participated in load testing, helped in finding other group's bugs during PED.
* Helped peer in forum.
63 changes: 25 additions & 38 deletions docs/team/pearlynnt.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,70 +3,57 @@ layout: page
title: Pearlynn Toh's Project Portfolio Page
---

# Project: StudentConnect

# Overview
### Overview
StudentConnect is the solution for hassle-free team formation for CS2103T students to browse profiles and connect with others for group work.

# Summary of Contributions
### Summary of Contributions
Given below are my contributions to the project.

## Code contributed
**Code contributed**
* Link to my [RepoSense report](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=pearlynnt&breakdown=false&sort=groupTitle%20dsc&sortWithin=title&since=2023-09-22&timeframe=commit&mergegroup=&groupSelect=groupByRepos)

## Enhancements implemented
**Enhancements implemented**
* **Edit Student Feature**: Added the ability to edit a student's personal details
* What it does: This feature allows the user to edit a student's personal details in the system.
* Justification: This feature helps users to keep their personal details up-to-date. Details such as social media links or their preferred tutorial slots may change over time. This is important in ensuring that users remain contactable. This feature also allows users to correct any errors in their personal details. This is important in ensuring that users' personal details are accurate and complete.
* Justification: This feature helps users to keep their personal details up-to-date.
* Highlights: Modified the code to allow the new student fields to be editable.
* **Find Students Feature**: Added the ability to find student(s) by name
* What it does: This feature allows the user to find student(s) by name with any combination of partial keyword(s).
* Justification: This feature helps users to find other students more quickly and easily. Without this feature, users would need to know the exact spelling of a student's name in order to find them. With this feature, users can enter any combination of partial keywords, such as the first few letters of the student's name, their middle name, or their last name. This can be especially helpful for users who are not sure of the exact spelling of a student's name, or for users who are trying to find a student who has a common name.
* Highlights: Modified the code to check of each word in the students' name contains the keyword(s) instead of having to match the keyword(s).
* Justification: This feature helps users to find other students more quickly and easily.
* Highlights: Modified the code to check if each word in the students' name contains the keyword(s) instead of having to match the keyword(s).
* **Filter Students Feature**: Added the ability to filter students by tutorial
* What it does: This feature allows the user to filter students by tutorial with any combination of tutorial slot(s).
* Justification: This feature helps users to search for other students who are also interested in attending or are assigned to the same tutorial slot. Without this feature, users would need to manually scroll through the list of students to search for students who have indicated the same tutorial. With this feature, users can enter any combination of valid tutorial slot(s) to retrieve the list of students in the tutorial slot(s) provided. This is important because it allows users to search for other students who are available during the same preferred tutorial slot.
* Highlights: A new Predicate class had to be written to support this feature. Invalid tutorial slot(s) provided by the user had to be handled gracefully so that the user can understand how to proceed to use the command correctly.
* Justification: This feature helps users to search for other students who are also interested in attending or are assigned to the same tutorial slot.
* Highlights: A new Predicate class had to be written to support this feature. Invalid tutorial slot(s) provided by the user had to be handled gracefully.
* **Find Group Feature**: Added the ability to find a group by group number
* What it does: This feature allows the user to find a project group by a group number.
* Justification: This feature helps users to find a specific group more quickly and easily. Without this feature, users would need to manually scroll through the list of groups to find the group that they are searching for. With this feature, users can simply enter a group number and the system will return a list of all the group members.
* Highlights: A new Predicate class had to be written to support this feature. Invalid group number provided by the user had to be handled gracefully so that the user can understand how to proceed to use the command correctly.
* Justification: This feature helps users to find a specific group more quickly and easily.
* Highlights: A new Predicate class had to be written to support this feature. Invalid group number provided by the user had to be handled gracefully.
* **Filter Groups Feature**: Added the ability to filter groups by tutorial
* What it does: This feature allows the user to filter groups by a tutorial slot.
* Justification: This feature helps users to search for groups that belong to a particular tutorial that they may prefer. Without this feature, users would need to manually scroll through the list of groups to search for groups that belong to a particular tutorial. With this feature, users can enter a tutorial slot to retrieve the list of groups that belong to the tutorial slot provided.
* Highlights: A new Predicate class had to be written to support this feature. Invalid tutorial slot provided by the user had to be handled gracefully so that the user can understand how to proceed to use the command correctly.
* Justification: This feature helps users to search for groups that belong to a particular tutorial that they may prefer.
* Highlights: A new Predicate class had to be written to support this feature. Invalid tutorial slot provided by the user had to be handled gracefully.
* **Check Group Feature**: Added the ability to check if a group fulfils the diversity requirements of the course
* What it does: This feature allows the user to check the composition of a group's members.
* Justification: This feature helps users to check if a group fulfils the diversity group formation requirements of the course with a single command. Without this feature, users would need to manually find the details of each member in the group to check if the group meets the diversity requirements. With this feature, users can enter a group number to easily check the composition of the group members. This helps to ensure that users have the opportunity to work with and learn from others from different backgrounds.
* Highlights: Different warning messages were written to inform users of what the group may fall short of in terms of group formation so that the user can ensure that the members are from diverse backgrounds. Extensive test cases and test data were written to rigorously test the different possible composition of the group members.
* Justification: This feature helps users to check if a group fulfils the diversity group formation requirements of the course with a single command.
* Highlights: Different warning messages were written to inform users of what the group may fall short of in terms of group formation. Extensive test cases and test data were written to rigorously test the different possible composition of the group members.

## Contributions to the UG
* Added the 'Edit Command' section.
* Added the 'Find Command' section.
* Added the 'Filter Command' section.
* Added the 'Find Group Command' section.
* Added the 'Filter Group Command' section.
* Added the 'Check Command' section.
**Contributions to the UG**
* Added the 'Edit Command', 'Find Command', 'Filter Command', 'Find Group Command', 'Filter Group Command', 'Check Command' sections.
* Ensured consistent formatting of the content in the User Guide.

## Contributions to the DG
* Added the 'Edit a Student' use case.
* Added the 'Find a student' use case.
* Added the 'Filter students' use case.
* Added the 'Find a group' use case.
* Added the 'Filter groups' use case.
* Added the 'Check a group' use case.
**Contributions to the DG**
* Added the 'Edit a Student', 'Find a student', 'Filter students', 'Find a group', 'Filter groups', 'Check a group' use cases.
* Updated the Storage Class Diagram using PlantUML.

## Contributions to team-based tasks
* **Project management**:
* Set up the team's Github Repository, and project documentation.
* Managed the milestones on Github.
* Led the team's project meetings
**Contributions to team-based tasks**
* Set up the team's Github Repository, and project documentation.
* Managed the milestones on Github.
* Led the team's project meetings.

## Review/mentoring contributions
**Review/mentoring contributions**
* Reviewed the team's Github pull requests and gave comments where appropriate. (e.g., [#106](https://github.com/AY2324S1-CS2103T-F12-2/tp/pull/106), [#177](https://github.com/AY2324S1-CS2103T-F12-2/tp/pull/177), [#190](https://github.com/AY2324S1-CS2103T-F12-2/tp/pull/190))

## Contributions beyond the project team
**Contributions beyond the project team**
* Tested another team's product and reported bugs during PE-D. ([list of issues](https://github.com/PearlynnT/ped/issues))
* Participated in load testing.
Loading

0 comments on commit 8a87b50

Please sign in to comment.