Skip to content

Commit 95b1b7a

Browse files
ebouchutCopilot
andauthored
Apply suggestions from Copilot code review
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent a7ef0b0 commit 95b1b7a

3 files changed

Lines changed: 18 additions & 19 deletions

File tree

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ We agree to restrict the following behaviors in our community. Instances, threat
5050

5151
Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.
5252

53-
When an incident does occur, it is important to report it promptly. To report a possible violation, **send an email to ebouchut@gmail.com .**
53+
When an incident does occur, it is important to report it promptly. To report a possible violation, **send an email to ebouchut@gmail.com.**
5454

5555
Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.
5656

CONTRIBUTING.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ sequenceDiagram
8383
8484
FE->>API: POST /auth/login<br/>{ email, password }
8585
86-
API->>API: Validate request body (Joi)
86+
API->>API: Validate request body (server-side validation)
8787
alt Validation fails
8888
API-->>FE: 400 Bad Request<br/>{ message: [...errors] }
8989
FE-->>U: Show validation errors
@@ -115,20 +115,20 @@ We use a **monorepo**, that is a Git repository containing mainly both the **fro
115115
**Using a monorepo offers the following advantages:**
116116

117117
- **Shared code and types:**
118-
The *frontend* and *backend* can share types from a single source of truth, avoiding duplication and keeping
119-
- them in sync.
118+
The *frontend* and *backend* can share types from a single source of truth, avoiding duplication and keeping them in sync.
120119
- **Atomic changes:**
121-
A single commit or PR can update the database schema, backend API, and frontend together,
122-
- ensuring they stay compatible.
120+
A single commit or PR can update the database schema, backend API, and frontend together, ensuring they stay compatible.
123121
- **Easier code reviews:**
124-
Reviewers can see the full picture of a change (database + backend + frontend) in a single PR
125-
- rather than coordinating across multiple repositories.
122+
Reviewers can see the full picture of a change (database + backend + frontend) in a single PR rather than coordinating across multiple repositories.
126123
- **Consistent tooling and configuration:**
127124
Linting rules, formatting, CI/CD pipelines, and Git hooks are configured once and apply to all packages.
128125

126+
127+
128+
129129
#### Modules
130130

131-
The project is composed of 2 `modules:
131+
The project is composed of 2 modules:
132132

133133
- **`backend`**: Spring Boot app (in `backend/`)
134134
- **`frontend`**: React app (in `frontend`).
@@ -397,7 +397,7 @@ The *learn-dev* platform uses a PostgreSQL relational database to persist entiti
397397

398398
##### Database Naming Conventions
399399

400-
Here are the naming conventions for the **name** of our database **tables**:T
400+
Here are the naming conventions for the **name** of our database **tables**:
401401

402402
- All lowercase
403403
- Plural
@@ -410,7 +410,7 @@ Do not use an underscore as the first character.
410410
##### Database ERD Diagram
411411

412412
The **Entity Relationships Diagram** (ERD)
413-
is available as an [SVG image](https://raw.githubusercontent.com/ebouchut/learn)dev/dev/docs/ERD.svg)
413+
is available as an [SVG image](https://raw.githubusercontent.com/ebouchut/learn-dev/dev/docs/ERD.svg)
414414

415415
> [!NOTE]
416416
> This diagram uses [Crows's foot notation](https://mermaid.js.org/syntax/entityRelationshipDiagram.html#relationship-syntax)
@@ -463,12 +463,12 @@ send requests to the backend API directly from [Postman](https://www.postman.com
463463

464464
1. Open Postman.
465465
2. Click **`Collections`** / **`Import`**.
466-
3. Select `packages/backend/postman/learndev.collection.json`.
466+
3. Select `backend/postman/learndev.collection.json`.
467467

468468
#### Import the Postman environment
469469

470470
1. Click **`Environments`** / **`Import`**.
471-
2. Select `packages/backend/postman/learndev.environment.json`.
471+
2. Select `backend/postman/learndev.environment.json`.
472472
3. Select **learnDev – Local** as the active environment (top-right dropdown).
473473

474474
#### Configure the Postman Collection
@@ -721,9 +721,9 @@ to the **frontend**:
721721

722722
```shell
723723
cd frontend
724-
# IMPORTANT: first off run npm
725-
# Run npm (one-shot) to install the existing project's dependencies
726-
npm
724+
# IMPORTANT: first install dependencies with npm
725+
# Run npm install (one-shot) to install the existing project's dependencies
726+
npm install
727727

728728
npm install react react-dom
729729
npm install -D @types/react

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Learn-dev an Interactive Programming Learning Platform
1+
# Learn-dev: An Interactive Programming Learning Platform
22

33
## Presentation
44

@@ -28,8 +28,7 @@ and [React](https://react.dev/) frontend.
2828
### Backend
2929

3030
- Java 21
31-
- [Spring Boot](https://spring.io/projects/spring-boot) 3.x: Java Framework used to build (Web) Applications.
32-
and REST endpoints
31+
- [Spring Boot](https://spring.io/projects/spring-boot) 3.x: Java Framework used to build (Web) Applications and REST endpoints.
3332
- [Spring Security](https://spring.io/projects/spring-security): Authentication and authorization framework
3433
- [PostgreSQL](https://www.postgresql.org/about/) 15+: Database
3534
- [Maven](https://maven.apache.org/what-is-maven.html): Build and dependency management tool

0 commit comments

Comments
 (0)