Overview

NotUS is a quick and simple, Command Line Interface (CLI) based, note-taking application for keyboard-inclined users. NotUS allows for users to categorize notes by tagging as well as pinning the more important notes. NotUS is also designed to assist in planning timetables to highlight possible clashes.

  • Co-team lead: Responsible for overall project coordination alongside Jun Xiang.
  • Documentation and Code Quality: Responsible for the quality of various project documents and ensures adherence to coding standards.
  • Integration, Scheduling and Tracking: In charge of assigning, and tracking project tasks. Worked with Jun Xiang for the versioning of the code, maintaining the code repository, integrating various parts of the software.
  • In charge of list-n,archive-n, unarchive-n, find-n, of the code.

Summary of Contributions

Features implemented

1. Completed the following features and test code for them: archive-n: Allows the user to archive a note so their notebook is more organized and less cluttered, to access pertinent notes quicker. find-n: Allows the user to find a note by the note title, and retrieve them as opposed to scanning for them in the list, making the process efficient. help: Allows the user a quick access on commands available as the user might not recall all of the commands. list-n: Allows the user to see all available notes. Users can sort the notes in ascending/descending order for convenience, or list by tags, or view all archived notes. unarchive-n: Allows the user to unarchive a note if the user wants to make changes to the note.

2. In the Notebook class, created: archivedNotes, unarchivedNotes, getArchivedNotes, getNote, checkPinned, getSortedList, getPinnedNotes, getUnpinnedNotes, findNotes. In the Note class, created: toggleArchived, getIsArchived, getPinned. Added a couple of formatNotes methods into the Formatter class.

Enhancements to existing features

Added ASCII art (PR #90 and #80). Refactored code to abstract out the (un)successful execution messages (PR #143) to its own CommandMessage class.

Code contributed: RepoSense Link to view a report of the code contribution.

Contributions to Team Based Task

Set up the GitHub team organization and repository, maintained issues and reviewed almost all PRs alongside Jun Xiang, updated User/Developer documents that are not feature specific, set up and maintained PERT Chart and Gantt Chart, created a Development Practices Document.

Contributions to User Guide

Created the first draft of the User Guide. Filled up the following: Introduction, Quick Start, Initial draft of the features, including description and example codes, FAQ, Command Summary

Contributions to Developer Guide

Created the first draft of the Developer Guide. Filled up the following: Introduction, architecture overview, Product Scope (Target User Persona, Target User Profile and Value Proposition), User Stories, Non-functional requirements, Glossary, manual testing draft

Community