Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/AY2021S1-CS2113T-T09-1/tp
Browse files Browse the repository at this point in the history
…into basicLoggingOfFeatures

# Conflicts:
#	docs/DeveloperGuide.md
#	ezmanager.txt
  • Loading branch information
samuellleow committed Nov 9, 2020
2 parents 7e080ad + 5d5a8b0 commit 69ed5ce
Show file tree
Hide file tree
Showing 3 changed files with 83 additions and 401 deletions.
29 changes: 22 additions & 7 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,8 @@
![EZ Manager Welcome](https://i.ibb.co/n7zphMR/ezmanagerterminal.png)

## **Changelog**
Identifier | Changes | Date
---------- | ------------------- | ----
A | Incorporated feedback from CS2101 review <ul><li>Include table of content</li><li>Include preface for sections</li><li>Add introductory sections</li><li> Address the reader directly – “You”</li></ul> | 29 October 2020
B | final developer guide for CS2113T Team project<ul><li>Include table of content</li><li>Included updated command summary</li><li>Converted DG to Markdown</li><li> Included sequence diagrams</li></ul> | 09 November 2020
![EZ Manager Changelog](https://i.ibb.co/NNcdxnh/changelog.png)

---

## **Table of Contents**
Expand All @@ -17,7 +15,7 @@ B | final developer guide for CS2113T Team project<ul><li>Include table of conte
- [Implementation](#implementation)
- [Testing](#running-tests)
- Dev Ops
- [Making A Release](#devops---making-a-release)
- [Making A Release](#devops)
- Appendices
- [Appendix A: Product Scope](#Appendix-A-Product-Scope-Samuel-Leow)
- [Appendix B: Commands Summary](#Appendix-B-Command-Summary-Samuel-Paul-Christopher)
Expand Down Expand Up @@ -66,7 +64,7 @@ Developers are welcome to contribute by submitting issues or pull requests on ou
### **Consideration (Sean Tan)**
Eazy was developed via a breadth first iterative approach with new commands progressively added. An n-tier architecture ensured separation of concern between various layers of the architecture but much of the program’s logic remained in the Command classes. This design architecture ensured minimal changes to the codebase when new commands were added. Often, new commands or feature addition required changes to only a single data class and addition of a new independent command class.

### **Overall Architecture (Sean)**
### **Overall Architecture (Sean Tan)**
Ez Manager consists of 4 main layers:
* Ui: Handles the output of the app
* Logic: Command parser and executor
Expand Down Expand Up @@ -429,6 +427,23 @@ The following sequence diagram shows how the “Assign member to task” command

<center><img src="https://i.ibb.co/vdBdtg2/Figure16-3.png"></center>

### **Hours Worked By Worker Command (Sean Tan)**
This command allows project managers to view the total hours worked by a worker
The logic for this command is primarily written in TeamMemberHoursCommand class. It extends from the abstract Command class.
The steps below show how such a class is initialized and used to execute the command.

Step 1: Parser initializes TeamMemberHoursCommand by passing a hashmap of input parameters together with projectIndex into its constructor.
Step 2: Parse() method of TeamMemberDeleteCommand extracts the index of the member to be retrieved from the hashmap.
Step 3: ExecuteCommand() method of TeamMemberDeleteCommand is called by Duke main class, which passes it the program’s arraylist of members.
* The method getTasks() of the specific member is called which retrieves all the tasks the member was assigned.
* The method getActual() of each of these tasks is called which retrieves the actual time taken to complete these tasks.
* The total hours of these tasks are then summed up.
* The Ui class then prints the total number of hours worked by these workers.

The following sequence diagram shows how the “Hours Worked by worker” command works:

<center><img src="https://i.ibb.co/7Qms8Hc/hours.png"></center>

### **Removing a member from Home View(Sean Tan)**
This command allows project managers to remove members from the main members list in the home view.

Expand Down Expand Up @@ -728,7 +743,7 @@ There are two ways to run tests for EZ manager.
- On Windows, run the command `gradlew clean allTests` in a terminal
- On Mac or Linux, run the command `./gradlew clean allTests` in a terminal

## **DevOps - Making a Release (Samuel Paul Christopher)**
## **DevOps (Samuel Paul Christopher)**
Here are the steps to create a new release.
1. Update the version number in Duke.java
2. Generate a JAR file using Gradle
Expand Down
61 changes: 61 additions & 0 deletions ezmanager.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
Members
asd

Project two
status false
projectDescription <project description empty>
projectDeadline 2020-10-10
startTasks
endTasks
pMS
pME

Project one
status false
projectDescription <project description empty>
projectDeadline 2020-11-11
startTasks
endTasks
pMS
pME

Project p1
status false
projectDescription <project description empty>
projectDeadline null
startTasks
task1 | tS 0 tE | dS 2020-12-03dE | pS 0 pE
tsk2 | tS 0 tE | pS 1 pE
task3 | tS 0 tE | pS 0 pE
endTasks
pMS
pME

Project p2
status false
projectDescription <project description empty>
projectDeadline null
startTasks
endTasks
pMS
pME

Project p3
status false
projectDescription <project description empty>
projectDeadline 2020-12-12
startTasks
das | tS 0 tE | dS 2020-12-12dE | pS 0 pE
endTasks
pMS
pME

Project Web Development
status false
projectDescription <project description empty>
projectDeadline null
startTasks
endTasks
pMS
pME

Loading

0 comments on commit 69ed5ce

Please sign in to comment.