Skip to content

Commit 0bbc27b

Browse files
committed
updated the Copilot instruction, PR template, documentation and readme files to include frontend folder information
updated the Copilot instruction, PR template, documentation and readme files to include frontend folder information fixed markdown file lint issues as well
1 parent 8792e07 commit 0bbc27b

File tree

4 files changed

+24
-3
lines changed

4 files changed

+24
-3
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,11 @@ Please describe the tests that you ran to verify your changes. Provide instructi
4444

4545
## Validation Steps Performed
4646

47-
## PR Checklist:
47+
## Frontend Location and Stack
48+
49+
Frontend-related code is located in `/frontend/` at the repository root. It contains the Web interface and dashboard implemented with React, TypeScript, TailwindCSS and Socket.IO client for real-time features.
50+
51+
## PR Checklist
4852

4953
- [ ] My code follows the style guidelines of this project
5054
- [ ] I have performed a self-review of my own code

.github/instructions/copilot-instructions.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,15 @@ SDLC_core is a Python-based Software Development Life Cycle core project that pr
1212

1313
## Build and Validation Instructions
1414

15+
### Frontend
16+
17+
Frontend-related code and documentation is located in the `/frontend/` directory at the repository root. This contains the Web interface and dashboard source and docs. The frontend stack uses:
18+
- React
19+
- TypeScript
20+
- TailwindCSS
21+
- Socket.IO client for real-time communication
22+
23+
1524
### Prerequisites
1625

1726
**CRITICAL**: Always run dependency installation before any build or test operations:

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,11 @@ code:
6464

6565
### Shared Components
6666

67+
## Frontend
68+
69+
Frontend-related code and documentation is kept under the `/frontend/` directory at the repository root. This includes the Web interface and dashboard. The frontend is implemented with React, TypeScript, TailwindCSS, and uses the Socket.IO client for real-time communication.
70+
71+
6772

6873

6974
## Resources

doc/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1-
## Docu folder
1+
# Documentation
2+
3+
This directory contains the relevant documents important to the software.
4+
5+
Frontend-related code and dashboard documentation live in `/frontend/` at the repo root. The frontend uses React, TypeScript, TailwindCSS and Socket.IO client.
26

3-
This directory contains all the relevants documents important to the software.

0 commit comments

Comments
 (0)