Skip to content

Commit f1f4a43

Browse files
committed
docs: Improve the CONTRIBUTING.md adding steps about code-style for backend and frontend code
1 parent dd8d0ac commit f1f4a43

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,34 @@ Suggestions for improvements are also logged as [GitHub Issues](https://github.c
4949
4. Push to the original branch: `git push origin my-new-feature`.
5050
5. Create a Pull Request.
5151

52+
### Before Submitting a PR
53+
54+
To ensure your code follows the project's standards and passes the CI pipeline, please run the following commands before submitting your Pull Request.
55+
56+
#### Backend (Java/Quarkus)
57+
58+
Run the following command to clean, format, and package the application:
59+
60+
```bash
61+
./mvnw clean package
62+
```
63+
64+
This command will trigger the `impsort` and `formatter` plugins to ensure your imports and code style are correct.
65+
66+
#### Frontend (Angular)
67+
68+
Navigate to the frontend directory (`timeless-api/src/main/webui`) and run the code style check:
69+
70+
```bash
71+
cd timeless-api/src/main/webui
72+
npm run prettier:write
73+
```
74+
Or
75+
```bash
76+
npx prettier . --write
77+
```
78+
This script will check and apply the correct code style to your frontend code.
79+
5280
### PreRequisites
5381

5482
To run this project, you will need:

0 commit comments

Comments
 (0)