Skip to content
This repository has been archived by the owner on May 20, 2023. It is now read-only.

Latest commit

 

History

History
161 lines (128 loc) · 6.71 KB

truegitnovice.adoc

File metadata and controls

161 lines (128 loc) · 6.71 KB

Ahn TaeGyu - Project Portfolio

PROJECT: PlanWithEase

Hi! I am Ahn Tae Gyu, an Information Security student in National University of Singapore. I am keen on writing programs that help to improve qualities of our lives. You will be able to find brief introduction of the project along with some of my contributions to the project below.

Overview

PlanWithEase (PWE) is a degree planner desktop application designed to help National University of Singapore (NUS) Information Security freshmen in creating a comprehensive degree plan according to the degree requirements. PWE is designed to be simple and intuitive application that allows users to interact with by typing the commands (using a Command Line Interface). Moreover, PWE also comes with a clean Graphical User Interface (GUI) that presents information in an organized manner.Hence, even if you are unfamiliar with the Command Line Interface, you will not need to spend much time understanding how to use PWE. PWE was completed by a team of five members consisting of Ngo Wei Lin, Bai YunWei, Lee Yu Choy, Yeo Cheng Hong and me.

Ui

Understanding This Project Portfolio

The following symbols are used throughout this project portfolio:

ℹ️

This symbol denotes information that you may want to take note of when using the application.
💡

This symbol denotes a tip which you may find useful when using the application.
⚠️

This symbol denotes a warning message which you need to be careful of when using the application.

Additionally, you may also encounter the following text styles:

  • Commands or parameters will be in this format.

  • Important messages will be bold.

  • Undoable command will be in italics.

  • Keyboard buttons will be referred to as such: F1.

Summary of contributions

Given below is a summary of contributions I made in this project.

Major Enhancement: Degree Plan Management

Planner Move, Planner Show & Planner list

During this enhancement, Degree Planner model was build to allow other developer Bai YunWei and me to integrate planner related features into the application as well as stores degree plan related information.

  • Summary of the features:

    • Planner Move feature allows a module in the degree plan to be easily moved to another semester.

    • Planner Show feature allows displaying of specific semesters.

    • Planner list feature allows displaying of all semesters in the degree plan.

  • Justification:

    • Users can keep track of degree plan details (such as modules to take in particular semesters).

    • Users can easily make changes to the degree plan by moving a module in the degree plan with planner_move command.

    • Users can easily display specific semesters that the user wants with planner_show command.

  • Highlights:

    • During the enhancement, there were numerous reviews done to ensure that no other model components is broken and any degree plan related features can be integrated without any problem.

  • Planner Move was enhanced to carried out checks for the module’s co-requisite and semesters it and its co-requisites are offered in.

  • Planner Show was enhanced to utilize boolean expression parser that was designed by Lee Yu Choy.

  • Credits:

    • Plenty of module corrections and suggestions were made during the built of Degree Planner model by Ngo Wei Lin.

    • Boolean expression parser was designed by Lee Yu Choy.

Minor Enhancement: Adding UI segment for degree plan

  • Justification: UI part for degree plan was added to displays the semesters and modules to be taken during the semesters.

  • Highlights:

    • Browser Panel that existed originally have to be adjusted in order for the UI part of the degree plan to be added.

    • UI for Degree plan was updated to sort the degree plan before displaying.

  • Credits:

    • Beautification of the overall UI including the part for the degree plan was done by Lee Yu Choy

Other contributions:

  • Project management:

  • Enhancements to existing features:

    • Enhance planner_move feature to handle co-requisites as well as semester the modules are offered in (Pull Request #197)

    • Enhance planner_show feature to utilize BooleanExpressionParser (Pull Request #196) (Note: this was done during the implementation)

  • Documentation:

    • Update UI mock up for

      • v 1.1 (Pull Request #31)

      • v.1.2 (Pull Request #98)

    • Manage user guide (e.g. Pull Request #47)

    • Manage developer guide (e.g. Pull Request #2, #7)

    • Documentation management was mainly done through reviews (e.g. #172)

  • PRs reviewed: Approved Pull Requests

  • Issues:

    • Opened issues for enhancement and improvements that could be made (e.g. 164, 97)

Contributions to the User Guide

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

Contributions to the Developer Guide

Given below are sections I contributed to the Developer Guide. They showcase my ability to write technical documentation and the technical depth of my contributions to the project.