Skip to content

Commit 8f21179

Browse files
MasahisaSekitagithub-actions[bot]
authored andcommitted
Auto-formatted the code using Prettier
1 parent 2082fd3 commit 8f21179

File tree

2 files changed

+29
-21
lines changed

2 files changed

+29
-21
lines changed

doc/sprint3/RPM.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,41 +7,45 @@
77
### 1.1 Goals
88

99
- Develop enhanced scheduling features:
10+
1011
- Ability to insert, update, and delete timetable and events entries (course events for offered lectures, tutorial, etc and user events for users’ personal events) .
1112
- Automatic and customized timetable generation based on user constraints.
1213
- Custom colour customization for timetable entries.
1314
- Favourite timetable functionality.
14-
- Timetable Export/Share
15+
- Timetable Export/Share
1516
- Timetable compare
1617
- Email Notifications
1718

1819
- Build upon AI-powered assistant:
19-
- Timetable Generation via AI.
20-
- AI Chatbot refinement.
20+
21+
- Timetable Generation via AI.
22+
- AI Chatbot refinement.
2123

2224
- Project Deployment:
25+
2326
- Project has a usable dockerfile
2427
- Project is running on a VM instance
2528
- Project on update is automatically tested
26-
- Project auto redeploys on update
29+
- Project auto redeploys on update
2730

2831
- Unit Testing;
2932
- Project functions will have unit tests written for them
30-
- Project functions will pass unit tests written for them
31-
33+
- Project functions will pass unit tests written for them
3234

3335
### 1.2 Metrics for Measurement
3436

3537
- **Timetable Management**
38+
3639
- Users can create, modify, and delete timetables and event entries without errors.
3740
- Timetable generation respects user constraints (e.g., time preferences, course exclusions).
3841
- Custom colour selections persist across sessions.
3942
- Favourite timetables are stored and retrievable.
4043
- User generated timetables can be exported
41-
- Stored timetables can be compared to one another if the user has access to them.
44+
- Stored timetables can be compared to one another if the user has access to them.
4245
- Email notifications are sent to user based on upcoming timetable events
4346

4447
- **AI Assistant Features**
48+
4549
- AI can be queried to generate a timetable for the user based on a list of courses and a list of time restrictions
4650

4751
- **Deployment Features**
@@ -51,19 +55,22 @@
5155
- Project when updated and passing unit tests is auto-redeployed
5256

5357
**Unit Testing**
54-
- Project functions are unit tested so that their behaviour is clear and potential bugs are caught
55-
- Project functions passes unit tests so bug free functionality is ensured
58+
59+
- Project functions are unit tested so that their behaviour is clear and potential bugs are caught
60+
- Project functions passes unit tests so bug free functionality is ensured
5661

5762
## 2. Release Scope
5863

5964
- **Timetable Management**
65+
6066
- Add, update, and delete timetables and event entries.
6167
- Generate an optimized schedule based on user preferences.
6268
- Customize timetable entry colours.
6369
- Favourite timetables for quick access.
6470
- Export/Share timetables
6571

6672
- **AI Assistant**
73+
6774
- AI-Powered timetable generation
6875

6976
- **Deployment**
@@ -74,8 +81,8 @@
7481

7582
### 2.2 Excluded Features
7683

77-
7884
### 2.3 Bug Fixes
85+
7986
- Fix module importing linting errors
8087
- Fix Restriction creation bugs
8188
- Fix text highlight on edit username
@@ -90,4 +97,4 @@
9097
- The AI assistant relies on querying an external vector database and open AI. Bothe of these are online resources so if they are down our feature will be down as well.
9198
- The Timetable relies solely on the internal course database and installed dependencies. It does not fetch web-based content.
9299
- Unit testing relies solely on internal functions and installed dependencies. It does not fetch any web-based content.
93-
- The deployment relies on fetching the latest project version from github and (if it passes all unit tests) deploys the latest version on our google cloud virtual machine instance.
100+
- The deployment relies on fetching the latest project version from github and (if it passes all unit tests) deploys the latest version on our google cloud virtual machine instance.

doc/sprint3/iteration-03.plan.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ In addition to their specific roles, all team members have a collective responsi
3636

3737
#### Epic 3: Deployment
3838

39-
**Team Members:** Masahisa
39+
**Team Members:** Masahisa
4040

4141
- Create a dockerfile such that our application can be run on a docker image with application setup being done automatically.
4242
- Ensure that our application’s docker image runs on a VM instance accessible on the web.
@@ -59,6 +59,7 @@ In addition to their specific roles, all team members have a collective responsi
5959
- Define tasks and responsibilities for each team member
6060

6161
- **Stand up meeting**:
62+
6263
- Location: Online or in-person depending on members availability
6364
- Time: Every Tuesday from 12 pm to 1 pm, Thursday and Sunday from 9 pm to 10 pm
6465
- Purposes
@@ -107,11 +108,10 @@ In addition to their specific roles, all team members have a collective responsi
107108

108109
![Ticket Workflow](./images/Ticket_Workflow.png)
109110

110-
- Furthermore, we will implement a Burndown Chart, which will be included as `burndown.pdf` by the end of the sprint. This chart will also feature comments on the sprint's progress and a velocity comparison.
111-
- Below is an example Burndown Chart from Sprint 0:
112-
113-
![Burndown Chart](./images/Burndown.png)
111+
- Furthermore, we will implement a Burndown Chart, which will be included as `burndown.pdf` by the end of the sprint. This chart will also feature comments on the sprint's progress and a velocity comparison.
112+
- Below is an example Burndown Chart from Sprint 0:
114113

114+
![Burndown Chart](./images/Burndown.png)
115115

116116
## 2. Product
117117

@@ -128,19 +128,20 @@ In addition to their specific roles, all team members have a collective responsi
128128
- Entries Colour Customization: [SCRUM-51](https://cscc01-course-matrix.atlassian.net/browse/SCRUM-51)
129129
- Timetable Favourite: [SCRUM-57](https://cscc01-course-matrix.atlassian.net/browse/SCRUM-57)
130130
- Timetable Export/Share:
131-
[SCRUM-58](https://cscc01-course-matrix.atlassian.net/browse/SCRUM-58)
131+
[SCRUM-58](https://cscc01-course-matrix.atlassian.net/browse/SCRUM-58)
132132

133133
- _Epic 2: AI Assistant_
134+
134135
- Timetable Generation via AI:
135-
[SCRUM-31](https://cscc01-course-matrix.atlassian.net/browse/SCRUM-31)
136+
[SCRUM-31](https://cscc01-course-matrix.atlassian.net/browse/SCRUM-31)
136137
- Refine AI outputs:
137-
[SCRUM-132](https://cscc01-course-matrix.atlassian.net/browse/SCRUM-132)
138+
[SCRUM-132](https://cscc01-course-matrix.atlassian.net/browse/SCRUM-132)
138139

139140
- _Epic 3: Deployment_
140141
- Project Deployment:
141-
[SCRUM-130](https://cscc01-course-matrix.atlassian.net/browse/SCRUM-130)
142+
[SCRUM-130](https://cscc01-course-matrix.atlassian.net/browse/SCRUM-130)
142143

143-
**3. Create sprint3 documentation:**
144+
**3. Create sprint3 documentation:**
144145
[SCRUM-127](https://cscc01-course-matrix.atlassian.net/browse/SCRUM-127)
145146

146147
#### 2.2 Artifacts

0 commit comments

Comments
 (0)