Skip to content

Latest commit

 

History

History
58 lines (37 loc) · 2.72 KB

miaaaaa97.adoc

File metadata and controls

58 lines (37 loc) · 2.72 KB
Raw

Zhang Tieze - Project Portfolio

PROJECT: BookSquirrel

Overview

BookSquirrel(v1.3) is for those who want to keep a record of books they’ve read. More importantly, BookSquirrel is optimized for those who prefer to work with a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, BookSquirrel can get your note management tasks done faster than traditional GUI apps.

Summary of contributions

  • Major enhancement: added the Review feature.

    • What it does: allows the user to add, list, view, and delete reviews.

    • Justification: This feature enables the user to record their thoughts when they read books.

    • Highlights: This feature requires a lot of change to the UI and model of the application, meanwhile, it is closely linked to the book feature, which makes it challenging and bug-prone. To find a way to store reviews, many architectures were considered. Extra care was taken to integrate Reviews with existing Book commands, such as to cascade any deletion or editing of books.

  • Minor enhancement: fixed the bug that ConfigUtil will always output config.json with missing new line at end of file, which causes the travis build to fail unless a new line is manually added.

  • Code contributed: [Functional code]

  • Other contributions:

    • Project management:

      • Created and managed the Project board

      • Created and organized tags

    • Enhancements to existing features:

      • Wrote additional tests for existing features to increase coverage from 87% to 92% (Pull request #95)

    • Documentation:

      • Wrote the AboutUs and ContactUs documents. (Pull request #6)

      • Update diagrams in README page, UserGuide and DeveloperGuide. (Pull request #17, #21)

      • Re-organized existing contents of the User Guide and Developer Guide: (Pull request #95)

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.