Skip to content

Commit

Permalink
Merge pull request #32 from MadLamprey/branch-skeletalPPP
Browse files Browse the repository at this point in the history
Add Skeletal PPP for Aditya
  • Loading branch information
MadLamprey committed Oct 5, 2023
2 parents 3e8900b + 94bfa9f commit 6e2c8df
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 15 deletions.
52 changes: 37 additions & 15 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ JobApplicationsBook Pro (JABPro) is a **desktop app for hiring managers of compa
* `add linkedin 1 alexyeoh`: Adds LinkedIn account to candidate's existing contact information

* `github Alex Yeoh`: Redirects the user to the Github account of the candidate


1. Refer to the [Features](#features) below for details of each command.

Expand Down Expand Up @@ -65,7 +65,7 @@ JobApplicationsBook Pro (JABPro) is a **desktop app for hiring managers of compa
e.g. if the command specifies `help 123`, it will be interpreted as `help`.

* If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application.
</box>
</box>

### Viewing help : `help`

Expand Down Expand Up @@ -101,9 +101,29 @@ Format: `remark INDEX r/REMARK`
* The previous remark is not saved, and instead is replaced by the inputted remark. The command does not add to the existing remark
* You can empty out a remark by inputting an empty string

Examples:
Examples:
* `remark 1 r/Great attitude, hardworking` Edits the remark of the 1st person on the list to have a remark `Great attitude, hardworking`
* `remark 1 r/` Empties the remark of the 1st person.
* `remark 1 r/` Empties the remark of the 1st person.

### Adding Github/LinkedIn username for a user: 'add linkedin/github'

Adds the username for their social profile [LinkedIn/Github] to the existing contact details of users

Format: `add linkedin INDEX USERNAME` or `add github INDEX USERNAME`

Examples:
* `add github 2 MadLamprey`
* `add linkedin 4 aditya-misra`

### Opening user LinkedIn or GitHub account: 'linkedin' or 'github'

Redirect user to candidate's LinkedIn or Github account

Format: `linkedin NAME` or `github NAME`

Examples:
* `linkedin Alex Yeoh`
* `github Bernice Sanders`

### Listing all persons : `list`

Expand All @@ -122,7 +142,7 @@ Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`
* Existing values will be updated to the input values.
* When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.
* You can remove all the person’s tags by typing `t/` without
specifying any tags after it.
specifying any tags after it.

Examples:
* `edit 1 p/91234567 e/[email protected]` Edits the phone number and email address of the 1st person to be `91234567` and `[email protected]` respectively.
Expand Down Expand Up @@ -233,13 +253,15 @@ _Details coming soon ..._

## Command summary

Action | Format, Examples
-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------
**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​` <br> e.g., `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 t/friend t/colleague`
**Remark** | `remark r/REMARK` <br> e.g., `remark 1 r/Great attitude, hardworking`
**Clear** | `clear`
**Delete** | `delete INDEX`<br> e.g., `delete 3`
**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`<br> e.g.,`edit 2 n/James Lee e/[email protected]`
**Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake`
**List** | `list`
**Help** | `help`
Action | Format, Examples
---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------
**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​` <br> e.g., `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 t/friend t/colleague`
**Remark** | `remark r/REMARK` <br> e.g., `remark 1 r/Great attitude, hardworking`
**Add Github/LinkedIn** | `add linkedin INDEX USERNAME` or `add github INDEX USERNAME` e.g., `add linkedin 1 alex-yeoh`, `add github 2 bernicesanders123`
**Open Github/LinkedIn** | `linkedin NAME` or `github NAME` e.g., `linkedin Alex Yeoh`, `github Bernice Sanders`
**Clear** | `clear`
**Delete** | `delete INDEX`<br> e.g., `delete 3`
**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`<br> e.g.,`edit 2 n/James Lee e/[email protected]`
**Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake`
**List** | `list`
**Help** | `help`
26 changes: 26 additions & 0 deletions docs/team/madlamprey.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
layout: default.md
title: "Misra Aditya's Project Portfolio Page"
---

# Project: JABPRO
## Overview
JABPro aims to solve the problem of HR managers having to sort through tons of job applications.
It makes their life easier by allowing them to easily fetch important info about job applicants such as their contact details, application status etc. It serves as a one-stop addressbook for job applications.
## Summary of Contributions
**Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=madlamprey&breakdown=true)

**Enhancement implemented**:

**Contribution to the UG**:

**Contribution to DG**:
* Contributed to DG for non-functional requirements

**Contribution to team-based tasks**:
* Keeping track of deadlines and objectives

**Review/mentoring contributions**:

**Contributions beyond the project team**:

0 comments on commit 6e2c8df

Please sign in to comment.