tp

Cheng Jia Wei Andy - Project Portfolio Page

Project: MangaTantou

MangaTantou is a CLI application that allows manga editors to track their employees (manga authors) and various details about their works (mangas), such as their deadlines and sales revenue. The application is targetted towards editors that can type fast, allow them to quickly create and look up entries of interest!

Summary of Contributions

• New Feature: Addition of Authors and Mangas to Catalog
  • What it does: This feature allows editors to easily add both authors and their respective works (mangas) to an organized catalog using the catalog command. Through simple command inputs, editors can quickly populate a record of existing and prospective authors, as well as their mangas, for easy reference and monitoring.
  • Justification: Authors and their manga works represent core assets within the manga industry. For editors, managing these assets is essential to making informed business decisions, planning collaborations, and tracking work progress. The ability to efficiently catalog author and manga details helps editors maintain a clear overview of their roster and project timelines, supporting both strategic planning and day-to-day management.
  • Highlights: Recognizing that editors often work under pressure and may occasionally make mistakes, MangaTantou includes built-in checks to prevent errors like duplicate entries. For instance, if an editor tries to add an author or manga that already exists in the catalog, the application will alert them to the duplication. This functionality enhances data integrity within the catalog and reduces potential confusion caused by redundant entries.
• General Contributions: Base Implementation of Core Classes and Application Structure
  1. Abstract Classes and Inheritance Patterns: I developed foundational abstract classes such as Command, ArgumentFinder and TantouException, which served as templates for implementing concrete subclasses (e.g., AddAuthorCommand and AuthorArgumentFinder). By establishing these abstractions, I provided a clear and standardized approach for further development of functionalities within the application. This approach not only made the code more modular and reusable but also reduced redundant code by centralizing common logic, which my teammates could then easily extend in their respective features, simplifying the development of addtional functionalities.
  2. Program Structure and Packaging for Enhanced Organization: Beyond coding individual features, I organized the project’s structural layout by dividing it into several logical packages, including but not limited to the commands package for command-related classes and the constants package for storing shared constants. By mapping out the initial structure and defining interactions between core components, I facilitated a cohesive codebase where team members could develop their features independently while ensuring compatibility. This structured approach also gave team members a clearer understanding of the application’s organization and dependencies, streamlining their development process by establishing a consistent pattern for adding new components. This modular design allowed for incremental feature development while maintaining the cohesiveness of our codebase, resulting in a more efficient integration process.
• Others:
  • In v1.0, I had tried using the Apache Commons CLI Library as part of MangaTantou’s parsing architecture. While it worked as intended, the functionalities provided by the library were not as defensive as we had liked and I led the Parser rehaul to a simpler but more defensive implementation.
• Code Contributed: RepoSense Link
• Documentation:
  • User Guide
    • Added details regarding the usage of the catalog command #88
  • Developer Guide
    • Added implementation details and development guidelines regarding the Command class and subclasses #88
    • Added implementation details regarding the addition and deletion of Authors and Mangas #92
    • Added implementation details and development guidelines regarding the general parsing architecture #109
    • Added details regarding testing #123
  • Project Management
    • Coordinated internal milestones and tracked team progress to ensure deadlines were met
    • Organized and led team meetings to review project status, address challenges, and align on next steps
  • Community
    • PRs reviewed (with non-trivial comments): #29, #44, #48
    • Contributed to forum discussions (examples: 1, 2, 3)