Skip to content

Commit

Permalink
Merge pull request #223 from ryantzr1/PPPFinalDraft
Browse files Browse the repository at this point in the history
Update indiv PPP
  • Loading branch information
ryantzr1 authored Nov 13, 2023
2 parents c3176cc + 111297c commit 6ddb6cc
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 12 deletions.
8 changes: 4 additions & 4 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ Yellow boxes contain important warnings.
* [Tutorial: Navigating the application](#tutorial-navigating-the-application)
* [Features](#features)
* [Components of a Command](#components-of-a-command)
* [How to Read Command Formats](#how-to-read-command-formats)
* [General Input Guidelines](#general-input-guidelines)
* [Command Format Guidelines](#command-format-guidelines)
* [General Command Input Guidelines](#general-command-input-guidelines)
* [Features for managing company details](#features-for-managing-company-details)
* [Adding a company: `addCompany`](#adding-a-company-addcompany)
* [Deleting a company: `deleteCompany`](#deleting-a-company-deletecompany)
Expand Down Expand Up @@ -285,7 +285,7 @@ Every command in Connectify is a prompt for action. It's how you command the app

--------------------------------------------------------------------------------------------------------------------

### How to Read Command Formats
### Command Format Guidelines

Throughout this user guide, you'll encounter various [General Commands](#general-commands) specific to Connectify. Let's explore how to interpret these command formats.

Expand All @@ -310,7 +310,7 @@ Throughout this user guide, you'll encounter various [General Commands](#general

--------------------------------------------------------------------------------------------------------------------

### General Input Guidelines
### General Command Input Guidelines

Here are some guidelines when using any of Connectify's commands. Please follow this to ensure that Connectify understands you!

Expand Down
23 changes: 15 additions & 8 deletions docs/team/ryantzr1.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,18 @@ Connectify is a networking platform designed to help professionals efficiently m

Given below are my contributions to the project.

* **New Feature**: Implemented `addCompany` Command
* **New Feature**: Implemented `addCompany` Command [(Link to PR)](https://github.com/AY2324S1-CS2103T-T15-4/tp/pull/51)
* Implemented the `addCompany` command, enabling users to add company to their Connectify.
* This feature allows users to track the information of their company contacts, which is crucial in network management.
* Significance: Elevates Connectify's utility by streamlining professional network management with seamless company contact tracking.

* **New Feature**: Implemented `find` Command
* **New Feature**: Implemented `find`, `companies` and `people` Command [(Link to PR)](https://github.com/AY2324S1-CS2103T-T15-4/tp/pull/98)
* Developed the `find` command, allowing users to search for entities in Connectify based on the person name or company name.
* This feature also comes with `findCompany` and `findPerson` Commands where you can find company and people specific information.
* Update: `find` command is now deprecated as we feel that `companies` and `people` function allow users to find companies and people more efficiently.
* Significance: Enhances Connectify's user experience by enabling efficient search and retrieval of both individual and company-specific information, boosting productivity and information accessibility.

* **New Feature**: Implemented `deletePerson` Command
* **New Feature**: Implemented `deletePerson` Command [(Link to PR)](https://github.com/AY2324S1-CS2103T-T15-4/tp/pull/75)
* Implemented the `deletePerson` command, enabling users to delete a contact from a given company.
* This feature allows users to remove a person from a company's contact list.
* Significance: Provides users with a streamlined method to de-clutter and manage their contact lists within specific companies, optimizing organisation and enhancing user control.
Expand All @@ -31,21 +32,27 @@ Given below are my contributions to the project.
* Contributed to problem-solving by helping the team breakdown problems.

* **Enhancements to existing features**:
* To be added soon.
* Improved code readability and test suites. [(Link to PR)](https://github.com/AY2324S1-CS2103T-T15-4/tp/pull/117)

* **Critical Bug Identification and Resolution**:
* Played a pivotal role in identifying and resolving critical bugs, significantly enhancing Connectify's stability and performance.
* Demonstrated a keen ability to identify and solve complex software problems, significantly contributing to the improvement of overall software quality.

* **Documentation**:
* User Guide:
* Updated error messages for a few commands that were flagged during mock PE.
* Thoroughly tested UG and uncovered 2 potential big issues that we documented after.
* Updated error messages for a few commands that were flagged during mock PE. [(Link to PR)](https://github.com/AY2324S1-CS2103T-T15-4/tp/pull/186)
* Thoroughly tested UG and uncovered 3 potential big issues that we documented after.
* Created guidelines to teach users how to use our commands. [(Link to PR)](https://github.com/AY2324S1-CS2103T-T15-4/tp/pull/199)
* Developer Guide:
* Contributed significantly to the developer guide, making sure that the all the commands are clearly documented.
* Created most of the activity and object diagrams for Commands section.
* Created the documentation for most of the features we built, making sure that the all the commands are clearly documented. [(Link to PR)](https://github.com/AY2324S1-CS2103T-T15-4/tp/pull/121)
* Created PlantUML diagrams for `rank`, `addPersonNote`, `addCompanyNote`, `sharePerson` and `editCompany`, among others. [(Link to PR)](https://github.com/AY2324S1-CS2103T-T15-4/tp/pull/121)

* **Team-Based Tasks**:
* **Enhanced Code Robustness through Gradle Assertions**: Implemented assertions in Gradle to bolster code robustness, contributing to the software's overall reliability.

* **Tools**:
* **Proficiently Managed SourceTree, Git, and GitHub for Version Control**: Skillfully utilized Git, and GitHub for revision control and code management, ensuring efficient and organized development workflows.
* **Leveraged PlantUML for Diagram Creation**: Utilized PlantUML to generate diagrams for the Developer Guide, enriching the quality of documentation and making it more visually informative.
* **Used CodeCov for Code Coverage**: Utilized CodeCov to track code coverage and ensure that the project meets the minimum code coverage requirements.


0 comments on commit 6ddb6cc

Please sign in to comment.