Skip to content

Latest commit

 

History

History
104 lines (75 loc) · 5.53 KB

choongyx.adoc

File metadata and controls

104 lines (75 loc) · 5.53 KB

Choong Yong Xin - Project Portfolio for MoneyGoWhere

About the Project

MoneyGoWhere is a finance application built by my team and I as part of a Software Engineering Project. It was morphed from a basic command line interface Address Book. MoneyGoWhere is a personal finance application targeted at students at the National University of Singapore (NUS). It is designed to help students to keep track of all their spending and their related information such as date, cost and tags. Notable features include allowing users to set budget goals, view statistics, set reminders for bills and export their data to a .csv file.

My Role

My role was to implement the statistics and graph features. The following sections will illustrate these features in greater detail.

Below are a few icons and formatting which will be used in this document.

Note
 Important information that should be noted.
Tip
 Tips that can help you better navigate the application.

test: Command to be executed or a component, class or object in the architecture of the application.

Additional useful information for this section.

Summary of contributions

This section shows a summary of contributions I have made for the project.

  • Major enhancement: I implemented the statistics feature.

    • What it does: It allows the user to view their spending in the form of a pie-chart which organises the user’s expenditure based on tags.

    • Justification: This feature enhances the product significantly as it enables users to view their spending in the form of figures which is more reader-friendly. Furthermore, it allows users to be more informed of their spending habits as they are now aware of where they have spent most of their money on, enabling them to reflect on their spending habits.

    • Highlights: This enhancement required an in-depth understanding of the software architecture as it involves multiple components of the application.

  • Minor enhancement: I implemented the graph feature.

    • What it does: It organises the user’s expenditure based on date, allowing users to view their daily expenditure based on a date range provided.

    • Justification: It enables users to view how much they spend daily and also enable them to analyze trends in their spending amount over a particular period of time. This helps them to better analyze their spending habits.

    • Highlights: This enhancement also required an in-depth understanding of the software architecture as it involves multple components of the application.

  • Code contributed: [Collated code]

  • Other contributions:

    • Project management:

      • Helped track issues on the team repository using labels, milestones and project card

    • Enhancements to existing features:

      • Refactored and modified existing class Address to Cost to fit the needs of our application (Pull requests #61, #67, #71)

    • Documentation:

      • Vetted and formatted the entire User Guide after individual contributions by team members (Pull request #101)

      • Reviewed team member’s documentations (Pull requests #80, #85, #98)

      • Updated Quick Start section and created a set of symbols/legends for User Guide (Pull requests #50, #101)

      • Collated and updated profiles for all members of the team (Pull request #7)

      • Updated Setting Up, Documentation, Testing and DevOps sections of Developer Guide (Pull request #244)

    • Community:

      • PRs reviewed with non-trivial review comments (Pull requests #62, #70, #81)

      • Conducted manual testing, reported bugs and offered suggestions for our team (Examples: 1, 2, 3)

      • Conducted manual testing, reported bugs and offered suggestions for other teams in the class (Examples: 1, 2, 3)

Contributions to the User Guide

Given below are sections I contributed to the User Guide for the Statistics feature and Graph feature. They showcase my ability to write documentation targeting end-users.

Contributions to the Developer Guide

Given below are sections on the implementation of the Statistics feature and Graph feature I have worked on. They showcase my ability to write technical documentation and the technical depth of my contributions to the project.