Skip to content

Commit

Permalink
Merge pull request #199 from hjungwoo01/198-format-dg
Browse files Browse the repository at this point in the history
Format DG
  • Loading branch information
shayaansultan authored Apr 15, 2024
2 parents 0cd6744 + aa9a2c3 commit 76bc67e
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@

# ContactSwift Developer Guide

<!-- * Table of Contents -->
<page-nav-print />

## Table of Contents

1. [Acknowledgements](#acknowledgements)
Expand Down Expand Up @@ -47,7 +44,7 @@

## **Acknowledgements**

We gratefully acknowledge the assistance of GitHub Copilot in the development of ContactSwift. This AI programming assistant provided code suggestions and snippets that expedited our development process sometimes. It's important to clarify, though, that the fundamental ideas and high-level concepts of this project are entirely our own creation. Very often, we had to modify or rewrite or fix the code generated by Copilot to ensure it meets our project's requirements and standards.
We acknowledge the assistance of GitHub Copilot in the development of ContactSwift. This AI programming assistant provided code suggestions and snippets that expedited our development process sometimes. It's important to clarify, though, that the fundamental ideas and high-level concepts of this project are entirely our own creation. Very often, we had to modify or rewrite or fix the code generated by Copilot to ensure it meets our project's requirements and standards.

Additionally, we introduced a basic tasklist feature for each employee, a concept inspired by innovations in the industry, yet developed entirely with original code by our team to ensure it uniquely meets our product's standards and requirements.

Expand All @@ -61,6 +58,8 @@ Refer to the guide [_Setting up and getting started_](SettingUp.md).

---

<div style="page-break-before: always;"></div>

## **Design**

### Architecture
Expand Down Expand Up @@ -106,6 +105,8 @@ The sections below give more details of each component.

[Back to table of contents](#table-of-contents)

<div style="page-break-before: always;"></div>

### UI component

The **API** of this component is specified in [`Ui.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/Ui.java)
Expand Down Expand Up @@ -152,7 +153,7 @@ How the `Logic` component works:

Here are the other classes in `Logic` (omitted from the class diagram above) that are used for parsing a user command:

<puml src="diagrams/ParserClasses.puml" width="600"/>
<puml src="diagrams/ParserClasses.puml" width="500"/>

How the parsing works:

Expand Down Expand Up @@ -282,6 +283,8 @@ Step 2. The `DeleteCommand` is executed, calling `Model#deleteEmployee(target)`,

[Back to table of contents](#table-of-contents)

<div style="page-break-before: always;"></div>

### Delete by UID Command Implementation

The `DeleteCommand` is also implemented to allow users to remove employees from the list by their unique id. This functionality is crucial for users who need to manage their employee datasets, especially when there are multiple employees with the same name.
Expand Down Expand Up @@ -322,6 +325,8 @@ This is the sequence diagram that describes the steps:

<puml src="diagrams/FilterSequenceDiagram.puml" width="650" />

<div style="page-break-before: always;"></div>

#### Example Usage Scenario

1. **User Input**: The user types the command `filter t/developer`, intending to display employees tagged as developers.
Expand Down Expand Up @@ -555,6 +560,8 @@ _{more aspects and alternatives to be added}_

---

<div style="page-break-before: always;"></div>

## **Documentation, logging, testing, configuration, dev-ops**

- [Documentation guide](Documentation.md)
Expand Down Expand Up @@ -633,6 +640,8 @@ Your insights and contributions are invaluable to us and help ensure that Contac

---

<div style="page-break-before: always;"></div>

## **Appendix: Requirements**

### Product scope
Expand Down Expand Up @@ -777,6 +786,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
- 2a. If the UID does not exist:
- ContactSwift sends an error message to the user.


#### **Use Case: Filter Employees**

**System:** ContactSwift v1.4
Expand Down Expand Up @@ -829,6 +839,8 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

---

<div style="page-break-before: always;"></div>

## **Appendix: Effort**

This appendix provides an overview of the efforts involved in the development of our enhanced contact and task management application, which evolved from the original AB3 code base. This section details the difficulty level, challenges faced, effort required, and the achievements of the project.
Expand Down Expand Up @@ -859,6 +871,8 @@ In conclusion, the development of this enhanced contact and task management appl

---

<div style="page-break-before: always;"></div>

## **Appendix: Instructions for manual testing**

This section provides instructions on how to manually test the functionalities of the ContactSwift application. Manual testing involves simulating user actions to verify that each feature behaves as expected. It is essential to perform thorough manual testing to ensure the application is reliable and functions correctly under different scenarios.
Expand Down Expand Up @@ -1002,6 +1016,8 @@ These test cases are intended to cover the primary functionalities of the Contac

---

<div style="page-break-before: always;"></div>

### Glossary

- **Command Format**: Describes the syntax used to input commands in ContactSwift. Examples include adding or deleting contacts. Commands must adhere to this format for successful execution.
Expand Down

0 comments on commit 76bc67e

Please sign in to comment.