StockPal

Ko Jia Ling’s Project Portfolio page

Project - StockPal

StockPal is a command line interface (CLI) application designed to help small E-commerce business owners to manage their stock-taking effectively. Users would mostly interact with StockPal via text commands.

Given below are my contributions to the project.

• Code contributed: tP Code Dashboard Link.

• New feature: Added the ability to edit product details.
  • What it does: Allows the user to make modifications to the product name, quantity, price and description.
  • Justification: This feature improves the application significantly as a user can make mistakes when adding new products and the application should provide a convenient way to rectify them. Product details may also change over time (e.g. price) and the application should allow users to update the necessary details.
• New feature: Added the ability to display help page for commands.
  • What it does: Allows the user to view the help page for either all or specific commands.
  • Justification: Users may not know what features are available, or may forget the specific fields that a command requires. This feature improves the user’s experience by providing them a convenient way to obtain guidance on how to use the commands instead of referring to the external user guide.
  • Highlights: This enhancement requires comings up with an efficient way to standardise formatting of the help page for every command. Coming up with the logic was challenging as the way our components were structured. i.e. command information was stored within each command as static variables and hence unable to use polymorphism to access them.
• Enhancement to existing features
  • Reformat help feature code to avoid long methods and similar code: #53
• Documentation:
  • User Guide:
    • Added instructions for the Quick Start section, detailing how to download and run StockPal.
    • Added documentation for the features help and edit.
  • Developer Guide: #77
    • Created initial class diagram for Data component.
    • Created sequence diagram for Command component.
    • Added implementation details of the edit feature.
• Contributions to team-based tasks:
  • Created base code structure (Relevant PR) with assistance from @wjunjie01 to fix Gradle issues.
  • Formatting and bug fixes for User Guide (Relevant PRs: #93, #95)
  • Updating docs that are not specific to a feature: Quick Start (UG), Data & Command Component (DG)
• Review/mentoring contributions:
  • Regularly reviewed team’s PRs. >20 PRs reviewed (non-exhaustive list): #40, #43, #69, #174
• Community Contributions
  • Review other team’s PRs: CS2113-W13-4, CS2113-W14-2
  • Reported an above-average number of bugs in the PE-D: PE-D issues