Skip to content

Commit

Permalink
Merge pull request #347 from jason-chuah/branch-PEDBugs
Browse files Browse the repository at this point in the history 
Fix PE-D Bugs
  • Loading branch information
@gohqingkhang
gohqingkhang authored Nov 11, 2024
2 parents 73c2a6e + 37c6302 commit 29b4d7e
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 53 deletions.
77 changes: 32 additions & 45 deletions docs/DeveloperGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,6 @@

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

## **Acknowledgements**

_{ list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well }_

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

## **Setting up, getting started**

Refer to the guide [_Setting up and getting started_](SettingUp.md).
Expand All @@ -29,7 +23,7 @@ Refer to the guide [_Setting up and getting started_](SettingUp.md).

<puml src="diagrams/ArchitectureDiagram.puml" width="280" />

The ***Architecture Diagram*** given above explains the high-level design of the App.
The ***Architecture Diagram*** given above explains the high-level design of the app.

Given below is a quick overview of main components and how they interact with each other.

Expand All @@ -41,9 +35,9 @@ Given below is a quick overview of main components and how they interact with ea

The bulk of the app's work is done by the following four components:

* [**`UI`**](#ui-component): The UI of the App.
* [**`UI`**](#ui-component): The UI of the app.
* [**`Logic`**](#logic-component): The command executor.
* [**`Model`**](#model-component): Holds the data of the App in memory.
* [**`Model`**](#model-component): Holds the data of the app in memory.
* [**`Storage`**](#storage-component): Reads data from, and writes data to, the hard disk.

[**`Commons`**](#common-classes) represents a collection of classes used by multiple other components.
Expand Down Expand Up @@ -249,13 +243,6 @@ The following activity diagram summarizes what happens when a user executes a ne
* Pros: Will use less memory (e.g. for `delete`, just save the person being deleted).
* Cons: We must ensure that the implementation of each individual command are correct.

_{more aspects and alternatives to be added}_

### \[Proposed\] Data archiving

_{Explain here how the data archiving feature will be implemented}_


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

## **Documentation, logging, testing, configuration, dev-ops**
Expand Down Expand Up @@ -289,35 +276,35 @@ _{Explain here how the data archiving feature will be implemented}_

Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*`

| Priority | As a …​ | I want to …​ | So that I can…​ |
|----------|-----------------------------------------------------|-------------------------------------------------|------------------------------------------------------------|
| `* * *` | prepared teacher | add student's email | email the student when I need to |
| `* * *` | caring teacher | add student's name | call a student by his/her name |
| `* * *` | efficient teacher | add student's register number | identify a student more quickly |
| `* * *` | teacher wanting to split students for group project | add student's sex | see how many students of each gender I have |
| `* * *` | caring teacher | add student's address | visit a student who may be sick at home |
| `* * *` | prepared teacher | add student's contact number | call up the student when I need to contact him/her |
| `* * *` | prepared teacher | add student's emergency contact name | identify the person I am calling if there are emergencies |
| `* * *` | prepared teacher | add student's emergency contact number | notify the person in case of emergencies |
| `* * *` | prepared teacher | add student's class | identify which student is in which class |
| `* * *` | diligent teacher | remove a student from the app | ensure my records are accurate when they drop out |
| `* *` | caring teacher | add student's photo | know what my students look like |
| `* *` | lazy teacher | mass add student information | save the trouble of adding them one by one |
| `* *` | lazy teacher | mass delete all dummy data | save the trouble of removing them one by one |
| `* *` | diligent teacher | assign roles to students | manage students with the specific roles |
| `* *` | neat teacher | group students by their class | manage and access information by class |
| `* *` | teacher wanting to split students for group project | separate students into project groups | manage their project work within the app |
| `* *` | prepared teacher | update a student's information | have the most current details when there is a change |
| `* *` | diligent teacher | assign progress tags to individual students | categorise their performance in class |
| `* *` | efficient teacher | sort the students by name | arrange the students lexicographically for exam conditions |
| `* *` | caring teacher | add a comment for a student | take note of that student's particular trait |
| `* *` | strict teacher | track a student's submissions | see which students did not submit tasks on time |
| `* *` | strict teacher | track student attendance | address absenteeism and its impact on student performance |
| `* *` | diligent teacher | add a new test for all my students | keep track of all the students' results |
| `* *` | diligent teacher | add the scores of the students | have an overview of everyone's results |
| `*` | picky teacher | customize the app settings | align the configuration with my preferences |
| `*` | teacher who likes to have everything in one app | create a seating arrangement for the class | edit the seating arrangement any time |
| `*` | diligent teacher | export information of all my graduated students | store them into the school database |
| Priority | As a …​ | I want to …​ | So that I can…​ |
|----------|-----------------------------------------------------|-------------------------------------------------|---------------------------------------------------------------------|
| `* * *` | prepared teacher | add student's email | email the student when I need to |
| `* * *` | caring teacher | add student's name | call a student by his/her name |
| `* * *` | efficient teacher | add student's register number | identify a student more quickly |
| `* * *` | teacher wanting to split students for group project | add student's sex | see how many students of each gender I have |
| `* * *` | caring teacher | add student's address | visit a student who may be sick at home |
| `* * *` | prepared teacher | add student's contact number | call up the student when I need to contact him/her |
| `* * *` | prepared teacher | add student's emergency contact name | identify the person I am calling if there are emergencies |
| `* * *` | prepared teacher | add student's emergency contact number | notify the person in case of emergencies |
| `* * *` | prepared teacher | add student's class | identify which student is in which class |
| `* * *` | diligent teacher | remove a student from the app | ensure my records are accurate when they are no longer in the class |
| `* *` | caring teacher | add student's photo | know what my students look like |
| `* *` | lazy teacher | mass add student information | save the trouble of adding them one by one |
| `* *` | lazy teacher | mass delete all dummy data | save the trouble of removing them one by one |
| `* *` | diligent teacher | assign roles to students | manage students with the specific roles |
| `* *` | neat teacher | group students by their class | manage and access information by class |
| `* *` | teacher wanting to split students for group project | separate students into project groups | manage their project work within the app |
| `* *` | prepared teacher | update a student's information | have the most current details when there is a change |
| `* *` | diligent teacher | assign progress tags to individual students | categorise their performance in class |
| `* *` | efficient teacher | sort the students by name | arrange the students lexicographically for exam conditions |
| `* *` | caring teacher | add a comment for a student | take note of that student's particular trait |
| `* *` | strict teacher | track a student's submissions | see which students did not submit tasks on time |
| `* *` | strict teacher | track student attendance | address absenteeism and its impact on student performance |
| `* *` | diligent teacher | add a new test for all my students | keep track of all the students' results |
| `* *` | diligent teacher | add the scores of the students | have an overview of everyone's results |
| `*` | picky teacher | customize the app settings | align the configuration with my preferences |
| `*` | teacher who likes to have everything in one app | create a seating arrangement for the class | edit the seating arrangement any time |
| `*` | diligent teacher | export information of all my graduated students | store them into the school database |


### Use cases
Expand Down
8 changes: 4 additions & 4 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ Examples:

Adds the date and reason as to why the specified person in the student list is absent.

Format: `addAttendance INDEX ad/[DATE] ar/[REASON]`
Format: `addAttendance INDEX ad/DATE ar/[REASON]`

<box type="tip" seamless>

Expand Down Expand Up @@ -431,12 +431,12 @@ _Details coming soon ..._
| **Filter** | `filter [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [c/CLASS] [s/SEX] [r/REGISTER_NUMBER] [en/ECNAME] [ep/ECNUMBER] [t/TAG]…​`<br> e.g., `filter n/James p/90332234` |
| **List** | `list` |
| **Help** | `help` |
| **Add Emergency Contact Name** | `addEcName INDEX en/[EMERGENCY_CONTACT_NAME]` <br> e.g., `addEcName 1 en/John Doe` |
| **Add Emergency Contact Number** | `addEcNumber INDEX ep/[EMERGENCY_CONTACT_NUMBER]`<br> e.g., `addEcNumber 2 ep/91231234` |
| **Add Emergency Contact Name** | `addEcName INDEX en/[ECNAME]` <br> e.g., `addEcName 1 en/John Doe` |
| **Add Emergency Contact Number** | `addEcNumber INDEX ep/[ECNUMBER]`<br> e.g., `addEcNumber 2 ep/91231234` |
| **Add Exam** | `addExam ex/EXAM_NAME` <br> e.g., `addExam ex/Midterm` |
| **Add Exam Score** | `addExamScore INDEX ex/EXAM_NAME sc/EXAM_SCORE` <br> e.g., `addExamScore 1 ex/Midterm sc/70.0` |
| **Delete Exam** | `deleteExam ex/EXAM_NAME` <br> e.g., `deleteExam ex/Midterm` |
| **Add Attendance** | `addAttendance INDEX ad/[DATE] ar/[REASON]`<br> e.g., `addAttendance 1 ad/24-09-2024 ar/Sick` |
| **Add Attendance** | `addAttendance INDEX ad/DATE ar/[REASON]`<br> e.g., `addAttendance 1 ad/24-09-2024 ar/Sick` |
| **Add Submission** | `addSubmission sm/SUBMISSION_NAME` <br> e.g., `addSubmission sm/Assignment 1` |
| **Add Submission Status** | `addSubmissionStatus INDEX sm/SUBMISSION_NAME ss/SUBMISSION_STATUS` <br> e.g., `addSubmissionStatus 1 sm/Assignment 1 ss/Y` |
| **Delete Submission** | `deleteSubmission sm/SUBMISSION_NAME` <br> e.g., `deleteSubmission sm/Assignment 1` |
Expand Down
4 changes: 0 additions & 4 deletions src/main/resources/view/tableStyle.css
View file

This file was deleted.

0 comments on commit 29b4d7e

Please sign in to comment.