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
[CS2103-T11-3] Powerlifting Competition Coordinator (P.C.C.) #29
base: master
Are you sure you want to change the base?
[CS2103-T11-3] Powerlifting Competition Coordinator (P.C.C.) #29
Conversation
42730a1
to
de71759
Compare
* Update project website Specifically the AboutUs, ContactUs, and README page. * Edit AboutUs page Changed 'prof' to 'professor' Made changes to responsibilities, and added component ic for everyone.
* Update .gitignore * Enhance RemarkCommand Completed steps up till this step on the tutorial * Add Remark class to the model * Add placeholder element for remark to the UI * Modify Person to support Remark field * Update Storage Add Remark field to JsonAdaptedPerson class * Finalise UI - Connect Remark field to PersonCard * Modify RemarkCommand execute() method
* Change repo url * Update developer guide to include user stories, user profile, non-functional requirements, use cases * Edit repository URL * Edit repository URL to correct URL sorry the previous commit was incorrect
* Made changes to fit team's scope. * Added AddCommands and DeleteCommands. * Added Edit Commands * Added List and View commands. * Corrected repoUrl * Made changes to follow Joshua's implementations. Contains vaguely-implemented methods. * Changed parameters from EntityList to Model. Made some changes to follow Joshua's implementations. * Moved ENTITY_TYPE to a static constant stored in CliSyntax. * Updated code to use viewMinimal() and viewDetailed(). * Minor changes * Implemented potential ways of executing each Participant command. * Merge from upstream * Updated code to use Model#updateParticipant's return value. * Removed Commands associated with Issues. * Removed Commands associated with Issues. (cherry picked from commit cef6975) * Imported Entities and other objects. * Updated AboutUs.adoc and ContactUs.adoc
* Update UserGuide.adoc * Update UserGuide.adoc * Update UserGuide.adoc * Update UserGuide.adoc * Update UserGuide.adoc * Update UserGuide.adoc * Update UserGuide.adoc * Update UserGuide.adoc * Update UserGuide.adoc * Update UserGuide.adoc * Update UserGuide.adoc * Update UserGuide.adoc * Update UserGuide.adoc * Update UserGuide.adoc * Update UserGuide.adoc * Update UserGuide.adoc * Update UserGuide.adoc * Update UserGuide.adoc * Update UserGuide.adoc
* can type fast | ||
* prefers typing over mouse input | ||
* is reasonably comfortable using CLI apps | ||
|
||
*Value proposition*: manage contacts faster than a typical mouse/GUI driven app | ||
*Value proposition*: manage powerlifting competitions faster than a typical mouse/GUI driven app | ||
|
||
[appendix] | ||
== User Stories |
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.
The user story format is correct and the 3 parts are all present. The benefit matches the function nicely. Overall everything is in order and there is no missing user stories. Good job!
. Should come with automated unit tests and open source code. | ||
. Should come with a user guide and a developer guide. |
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.
These NFRs do not have anything to do with the system and they do not specify the constraints under which system is develeoped and operated.
== Use Cases | ||
== Use Cases (To Do) | ||
|
||
(For all use cases below, the *System* is the `Powerlifting Competition Competitor` and the *Actor* is the `user`, unless specified otherwise) |
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.
The use of the term user can be better defined: e.g. athlete/participant
*Extensions* | ||
|
||
[none] | ||
* 2a. The list is empty. |
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 your system can show an error message when the list is empty
docs/DeveloperGuide.adoc
Outdated
*MSS* | ||
|
||
1. User obtains a list of competitions by listing (<<Use case: UC1 - View my competition list, *UC1*>>) | ||
2. User requests for a new powerlifting competition to be deleted. |
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.
Can cancel the word 'new'
docs/DeveloperGuide.adoc
Outdated
|
||
1. User obtains a list of competitions by listing (<<Use case: UC1 - View my competition list, *UC1*>>) | ||
2. User requests for a new powerlifting competition to be deleted. | ||
3. System adds the new competition to the user's competition list. |
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.
Should be delete instead of add
|
||
*MSS* | ||
|
||
1. User obtains a list of competitions by listing (<<Use case: UC1 - View my competition list, *UC1*>>) |
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.
Underline the listing with the UC1 since it is referenced. Also, whenever you reference a use case, the same name has to be used
docs/DeveloperGuide.adoc
Outdated
* 2a. System does not find any athletes satisfying all the constraints. | ||
+ | ||
[none] | ||
** 2a1. System shows an empty list. |
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.
Maybe showing an error message would be clearer for the user instead of an empty list
docs/DeveloperGuide.adoc
Outdated
1. User obtains a list of athletes by listing (<<Use case: UC5 - View my athlete list, *UC5*>>). | ||
or searching (<<Use case: UC6 - Search for athletes,*UC6*>>). | ||
2. User requests to view more information on a specific athlete in the list. | ||
3. System shows detailed information of the book. |
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 it's athlete instead of book
docs/DeveloperGuide.adoc
Outdated
|
||
1. User requests for an athlete to be added. | ||
2. User inputs athlete data. | ||
3. User confirms that the addition of the athlete cannot be reversed. |
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.
Why is this relevant since you can delete a athlete in UC10
* Made changes to fit team's scope. * Added AddCommands and DeleteCommands. * Added Edit Commands * Added List and View commands. * Corrected repoUrl * Made changes to follow Joshua's implementations. Contains vaguely-implemented methods. * Changed parameters from EntityList to Model. Made some changes to follow Joshua's implementations. * Moved ENTITY_TYPE to a static constant stored in CliSyntax. * Updated code to use viewMinimal() and viewDetailed(). * Minor changes * Implemented potential ways of executing each Participant command. * Merge from upstream * Updated code to use Model#updateParticipant's return value. * Removed Commands associated with Issues. * Removed Commands associated with Issues. (cherry picked from commit cef6975) * Imported Entities and other objects. * Updated AboutUs.adoc and ContactUs.adoc
Incorrect PR name corrected. Please take note of your correct team ID ... |
* Set up models * Remove attempt and participation models
* Update .gitignore to exclude all .iml files * Create Attempt and Participation packages * Remove trailing white spaces in UserGuide.adoc
* Ui.png added to UG * Ui.png added to UG with space * New Ui.png * Delete Ui.png * Add files via upload
* Make generic storage * Add Json classes for participation and competition
* Create ObservableList for the different Attempts * Add Exceptions * Change Attempt, Exercise, Participation classes as well as updated changes to review PR * Optimise imports * Minor changes * Add JavaDoc Comment in Participation.java
* Person class changes propagated Update code to pass checkstyle Fixed customDate equals method Change name from String to Name class Update tests due to changes in Person class * Update src/main/java/seedu/address/model/person/CustomDate.java Co-Authored-By: Christabel <50402053+belbel98@users.noreply.github.com>
…on class (#38) * Refactor participation class * Add participation data storage
For the participation feature
* New Branch * CRUD for Competitions * CRUD added to front end * Remove trailing whitespace from user guide
LGTM
* Add documentation to developer guide * Add more documentation to the developer guide
and other minor changes
* Bug Fix Bug fix for starting competition session not in filtered competition list * Fix deleteParticipation result error
@shawnkoh @HoWeiChin @Belbel98