Skip to content

Commit

Permalink
Merge pull request #229 from ashleygoh1/ppp
Browse files Browse the repository at this point in the history
update ppp & test cases
  • Loading branch information
ashleygoh1 authored Apr 20, 2024
2 parents ec51a63 + 21df6d5 commit e91b3f3
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 29 deletions.
36 changes: 16 additions & 20 deletions docs/team/ashleygoh1.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,22 @@ InternHub is a desktop address book application used for teaching Software Engin

Given below are my contributions to the project.

* **New Feature**: Allow user to add new contact to InternHub
* What it does: Allow user to add the internship information that they applied for
* Justification: This feature allow users to conveniently store all relevant internship details in one centralized location alongside their other contacts. This helps them stay organized and easily access internship information when needed.
* Credits: The feature builds upon the robust foundation of AB3, optimizing code to accommodate new parameters.
* **New Feature**: Allow users to add new contacts to InternHub
* What it does: Enables users to input information about the internships they have applied for.
* Justification: This feature enables users to conveniently store all relevant internship details in one centralized location alongside their other contacts. This helps them stay organized and easily access internship information when needed.
* Credits: The feature builds upon the robust foundation of AB3, optimizing the code to accommodate new parameters.

* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s2.github.io/tp-dashboard/?search=ashleygoh1&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2024-02-23&tabOpen=false)

* **Project management**:
* Managed releases `v1.3` (1 releases) on GitHub

* **Enhancements to existing features**:
* Update existing tests for existing features with coverage of 78.571% (Pull requests [\#9](https://github.com/AY2324S2-CS2103T-F14-1/tp/pull/9), [\#48](https://github.com/AY2324S2-CS2103T-F14-1/tp/pull/48)
* Update UI for PersonCard to display essential information only (Pull request [\#71](https://github.com/AY2324S2-CS2103T-F14-1/tp/pull/71))
* Add descriptive labels to UI PersonCard for clarity (Pull request [\#71](https://github.com/AY2324S2-CS2103T-F14-1/tp/pull/71))
* Show a '-' in UI if note or interview date is empty (Pull request [\#83](https://github.com/AY2324S2-CS2103T-F14-1/tp/pull/83))
* Update compareInterviewDates() function found in Person.java to fix app crash (Pull request [\#190](https://github.com/AY2324S2-CS2103T-F14-1/tp/pull/190))
* Enhanced test cases for existing features, achieving a test coverage of 78.571% (Pull requests [\#9](https://github.com/AY2324S2-CS2103T-F14-1/tp/pull/9), [\#48](https://github.com/AY2324S2-CS2103T-F14-1/tp/pull/48)).
* Designed an intuitive UI for the PersonCard to display essential information only (Pull request [\#71](https://github.com/AY2324S2-CS2103T-F14-1/tp/pull/71)).
* Added descriptive labels to the UI PersonCard (Pull request [\#71](https://github.com/AY2324S2-CS2103T-F14-1/tp/pull/71)).
* Implemented a '-' display in the UI when the note or interview date is empty (Pull request [\#83](https://github.com/AY2324S2-CS2103T-F14-1/tp/pull/83)).
* Updated the compareInterviewDates() function in Person.java to prevent app crashes (Pull request [\#190](https://github.com/AY2324S2-CS2103T-F14-1/tp/pull/190)).

* **Documentation**:
* User Guide:
Expand All @@ -51,18 +51,14 @@ Given below are my contributions to the project.
[10](https://github.com/ashleygoh1/CS2103-T-PE-Dry-run/issues/10))

* **Challenges and Problem Solving**:
* I was in charge of adding new fields to the person model. This required many changes throughout the project.
At the start, I thought this was a simple process but as I ran the code, errors started appearing, with more than 20% of the test cases failing.
Rather than editing everything at once, I broke down the error into smaller, manageable chunks. This allows me to test each change as I go to catch errors early and minimize the debugging effort.
After 2 days, I managed to update the code accordingly, pass all test cases and improve the code coverage from 75.26% to 78.571%.
* I was tasked with adding new fields to the person model, which required extensive changes throughout the project. This involved creating classes for the additional fields and test cases for each one. Additionally, I had to modify all existing test cases to accommodate the new fields. Initially, I underestimated the complexity of this task, and upon running the code, I encountered many errors, with over 20% of all test cases failing. Instead of attempting to edit everything at once, I broke down the errors into smaller, manageable chunks. This approach allowed me to test each change as I progressed, identifying errors early and minimizing debugging efforts. After two days of diligent work, I successfully updated the code, passed all test cases, and improved the code coverage from 75.26% to 78.571%.

* I created a pull request (PR) at the same time as one team member. I merged my teammate's PR first and when I wanted to merge my PR, merge conflict was shown.
I was panicking as I am used to fixing the conflict on the GitHub website. Yet for this PR, GitHub showed that the conflict was too complicated and required me to fix it on my laptop.
I kept myself calm and updated about the issue with my teammates. Thankfully, one of my team members was able to resolve the merge conflict by pulling the latest changes from the main branch to her local repository, manually resolving the conflict using a code editor, before successfully merging the PR without further issues.
* During a pull request (PR) submission, I created a PR at the same time as one teammate.
I merged my teammate's PR first and as I tried to merge my PR, there was merge conflict.
I was panicking as I was accustomed to resolving conflicts on the GitHub website and this conflict was too complex and required resolution on my local machine. Maintaining composure, I communicated the issue with my team members. Thankfully, one of my team members was able to resolve the merge conflict by pulling the latest changes from the main branch to her local repository, manually resolving the conflict using a code editor, before successfully merging the PR without further issues.

* **Tools**:
* Set up codecov to the team repo
* Set up UserGuide.md and DeveloperGuide.md
* Set up team's GitHub repo

* Configured codecov for the team repository.
* Set up UserGuide.md and DeveloperGuide.md.
* Set up the team's GitHub repository.

8 changes: 4 additions & 4 deletions docs/team/chenyixin0.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: default.md
title: "Yixin's Project Portfolio Page"
layout: default.md
title: "Yixin's Project Portfolio Page"
---

<div style="display: flex; justify-content: space-between; align-items: center;">
Expand All @@ -13,9 +13,9 @@
#### Project Overview
* InternHub is a productivity tool designed to help Undergraduate students manage their internship applications.
* The user interacts with it using a CLI, and it has a GUI created with JavaFX.
*

* It is written in Java, and has about 10 kLoC.
*




Expand Down
4 changes: 1 addition & 3 deletions docs/team/eunrcn.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@ title: "Eunice's Project Portfolio Page"

## Eunice's Project Portfolio Page

### Project: AddressBook Level 3

AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.
InternHub is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ public class CommandTestUtil {
public static final String VALID_TAG_INTERVIEW = "I";
public static final String VALID_JOB_DESCRIPTION_AMY = "Data Science intern";
public static final String VALID_JOB_DESCRIPTION_BOB = "Front end developer intern";
public static final String VALID_INTERVIEW_DATE_AMY = "15-04-2024 0900";
public static final String VALID_INTERVIEW_DATE_BOB = "15-04-2024 1200";
public static final String VALID_INTERVIEW_DATE_AMY = "15-04-2030 0900";
public static final String VALID_INTERVIEW_DATE_BOB = "15-04-2030 1200";
public static final String VALID_INTERN_DURATION_AMY = "6 months";
public static final String VALID_INTERN_DURATION_BOB = "3 months";
public static final String VALID_SALARY_AMY = "500";
Expand Down

0 comments on commit e91b3f3

Please sign in to comment.