Ryan Chua's Project Portfolio Page
Project: SectresBook
SectresBook helps secretaries to maintain all the information of the members of their club by collating a list of identifiable information, past records and future tasks.
Given below are my contributions to the project.
-
Code contributed: RepoSense link
- Enhancements implemented:
- Enhancement: Restructure
Tag- Restructure
Tagsuch that SectresBook has aUniqueTagMappingthatPersonandNotereferences. This allows SectresBook to only require oneTagobject per unique tag, instead of eachPersonandNoteneeding their ownTagobjects. - In addition, every
Taghas aPersonlist containing references ofPersonobjects that are “tagged” with theTag. - This would allow for future features to better make use of
Tag.
- Restructure
- Feature: Locating persons and notes by tag :
findTag- What it does: Finds
Persons andNotes in SectresBook that have the given tags. - Justification: This feature improves the product because secretaries can give
Persons andNotes tags and find them by those given tags when they are needed in the future.
- What it does: Finds
- Enhancement: Added the
Tagfunctionality toNote- Updated
Noteto have aTagset. - Updated
Notecommands to work withTagfunctionality.
- Updated
- Added tests to ensure that
Tagfunctionality works properly
- Enhancement: Restructure
- Contributions to the UG:
- Added section for Locating persons and notes by tag :
findTag- Brief description and explanation
- Screenshot for example
- Did final polishing and checks for UG
- Language use
- Formatting
- Organization
- Links
- Conversion to final PDF
- Added section for Locating persons and notes by tag :
- Contributions to the DG:
- Updated
Modelcomponent UML class diagram to reflect the correct associations betweenUniqueTagMapping,Person,NoteandTag. - Added section for Find Person by Tag feature
- Brief description, explanation and design considerations
- Sequence diagram
- Updated
- Contributions to team-based tasks:
- Setting up the correct Codecov and CI links at the start.
- Managed the release v1.3.trial for the trial JAR activity.
- Review/mentoring contributions:
- Read through, checked and approved team PRs.
- Occasionally offered suggestions or fixes for typos.
- Contributions beyond the project team:
- Gave comments and suggestions for the bugs I found during the PE-D activity.