Overview
Overview
semester.config is a desktop application for managing your tasks. While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).
Summary Of Contributions
Code Contributed
You can see my code contributions here.
Enhancements implemented
I implemented
- Sorting feature according to pre-defined parameters
- Daily task list that allows users to add and remove existing tasks into a daily planner
- Ability to add notes to a task, which allows a user to jot down any quick remarks related to the task
- Weightage attribute that allows users to capture the percentage weightage of their tasks
- UI enhancements, such as colour coding priority tags, adding emojis for task status and creating additional headers for
All tasks
andDaily tasks
Enhancement 1: Sorting Feature
(Pull requests #140, #183)
What it does: This feature allows the user to sort semester.config according to any one of the five specified parameters mentioned above. It sorts the tasks and displays them according to this order:
- Date and time - chronological
- Module code - lexicographical
- Priority tag - HIGH > MEDIUM > LOW
- Task name - lexicographical
- Weightage - descending
Justification: The motivation behind implementing this feature is to allow users to view their tasks in a preferred order, e.g. viewing the assignments that are due the soonest.
Highlights: Initially, I only planned to do the first 3 parameters. However, I realised that the implementation of the sorting feature could be easily extended to include parameters 4 and 5, and hence added them in for more flexibility for the user.
Enhancement 2: Daily task list
(Pull request #182)
What it does: Displays a daily task list that the user can view as a to-do list for the day. The user can manually add or remove tasks from this daily task list by selecting the task index from the All tasks list.
Justification: This feature adds an extra dimension to the functionality of the application, as it allows the user to not only just view the tasks that he/she has, but select those that he/she wants to focus on today and plan their schedule accordingly for the day.
Highlights: This feature proved challenging to implement, as it required an additional UniqueTaskList to be added to the TaskTracker, along with the relevant methods required to update it. Furthermore, I needed to take into account the modification of tasks on the All tasks list, and propagate any updates to the dailyTaskList.
Credits: I got the inspiration for this idea from Notion, as I personally use Notion to record down all my tasks and to plan my schedule for my days.
Enhancement 3: Notes feature
(Pull request #77)
What it does: Allows user to add any additional notes that he/she might have to a task.
Justification: A task might sometimes have additional attributes to take note of, or a user might have a certain idea as to how to approach a particular assignment. The notes feature allows the user to quickly capture and save these thoughts so that he/she can refer back to them in the future.
Enhancement 4: Weightage attribute
(Pull request #81)
What it does: Provides a weightage component for each task.
Justification: Many assignments in School of Computing have weightages associated with them, and students might choose to prioritise those tasks that have a higher weightage. Therefore, having the weightage associated with the task allows them to quickly view how much each assignment is worth, and prioritise their work based on that information.
Enhancement 5: UI enhancements
(Pull request #198, #208, #283)
The UI enhancements implemented include colour coding the priority tags (HIGH = red
, MEDIUM = yellow
, LOW = green
), adding emojis for status of tasks (finished ☑
and not finished ☒
), adding headers for All tasks
and Daily tasks
, and ensuring that the Notes
label had a style of wrap text
.
What it does and justification: Provide the user with a more pleasant experience while using the application. In particular, the colours associated with the priority tags accurately reflect the severity and priority of the tasks, and allow users to more easily identify which tasks are more urgent.
Highlight: Despite being a seemingly simple feature, colour coding the priority tags proved to be more complicated than I initially assumed it to be. It required the styleProperty of the priority tag component in the UI to be bound to its State, and to be dynamically updated when the priority tag values were updated by the user. Nonetheless, it was an interesting feature that allowed me to learn how to dynamically bind and generate elements using JavaFX.
Contributions to the User Guide (UG)
- Helped to refine the overall format and cosmetics of the UG (Pull request #204)
- Added table to outline all available prefixes and parameters that can be used for the
add
andedit
commands (Pull request #204) - Add usage description for
notes
command (Pull request #282) - Add usage description for
sort
command (Pull request #204) - Add usage description for
doToday
command (Pull request #204) - Format Command summary table (Pull request #204)
Contributions to the DG
- Add sorting feature implementation details (Pull request #160)
Contributions to team-based tasks
- Set up the GitHub team organisation and repository
- Generally helped to refactor certain codes to morph the address book into a task tracker
- Update target user profile, value proposition, user stories and glossary (Pull request #30)
- Maintain the issue tracker, and assigned people to tasks
- Facilitate the agenda and flow of team meetings most of the time
- Review, approve and merge PRs for the team